Skip to content

README.md

Latest commit

 

History

History
151 lines (113 loc) · 6.31 KB

README.md

File metadata and controls

151 lines (113 loc) · 6.31 KB
Raw

@sentilis/cli

The official command-line interface for the Sentilis platform.

NPM Version Package License NPM Downloads

cover.png

How your entry looks on Sentilis. See it live →

Description

The Sentilis CLI is a powerful tool designed to seamlessly bridge your local development workflow with the Sentilis platform. Built on top of @sentilis/core, it enables you to confidently validate, manage, and push content directly from your terminal using simple, trackable Markdown files.

Installation

Install the CLI globally using npm:

$ npm install -g @sentilis/cli

Note: You can also execute it on the fly using npx (e.g., npx @sentilis/cli list).

Getting Started

1. Authentication

To use the CLI, you must first authenticate with your personal token.

Get your token at https://id.sentilis.me/login.

$ sentilis auth login <your-token>

Other authentication commands:

  • sentilis auth whoami: Display the active profile.
  • sentilis auth profiles: List all saved profiles.
  • sentilis auth logout: Remove the active profile.
  • sentilis auth logout --all: Remove all saved profiles.

Global Options

  • --profile <name>, -p: Use a specific authentication profile.

2. Bio Commands

Manage your Sentilis Bio (resume / profile). New to Bios? Read What is a Bio?.

  • Push: Deploy a bio from a Markdown file or a directory of language variants. Use --dry-run to validate syntax and assets without pushing. 
    $ sentilis bio push ./examples/personal-brand/bio
  • List: View your bios. 
    $ sentilis bio list
  • Info: Get details of a bio, including its language variants. 
    $ sentilis bio info <id>
  • Remove: Delete a bio. 
    $ sentilis bio remove <id>

3. Press Commands

Manage your Sentilis Press entries and articles. New to Press? Read What is a Press?.

  • Push: Deploy an article from a Markdown directory. Sentilis automatically handles multi-file structures and assets. 
    $ sentilis press push ./examples/bigtech/press/scaling-10m-rpm

    Cover image: if no cover: field is set in frontmatter, the CLI auto-detects ./attachments/cover.{png,jpg,jpeg,webp} as the cover.

  • List: View your press entries. Use --visibility to filter by access level (e.g., public, private, protected, prime). Defaults to public. Multiple values can be comma-separated. 
    $ sentilis press list --visibility=public,private
  • Info: Get detailed information about a specific press entry, including its children. 
    $ sentilis press info <id>
  • Remove: Delete a press entry. 
    $ sentilis press remove <id>

4. Market Commands

Manage your Sentilis Market products. New to Market? Read What is Market?.

  • Push: Validate and deploy a new product from a Markdown file. Use --dry-run to validate syntax and attachments without pushing. 
    $ sentilis market push ./examples/solofounder/market/lifetime-deal/lifetime-deal.md
  • List: View your published market products. 
    $ sentilis market list
  • Attach: Upload a private attachment (e.g. PDF, ZIP) to an existing product, identified by ID. The file is stored privately on S3 and linked to the product. 
    $ sentilis market attach <id> ./file.pdf
  • Remove: Delete a product from the market. 
    $ sentilis market remove <id>

5. Sync

Validate and publish every entry under a workspace directory in one shot. A workspace is a folder containing any of bio/, press/, or market/ — typically one persona per workspace, the same layout the examples/ directory uses. Designed for the same flow locally and in CI: install, login, run sentilis sync.

  • Push everything (lenient, default): Walk the workspace, validate each entry, report issues on bad ones, and publish the clean ones. Use this when partial progress is preferable. 
    $ sentilis sync ./examples/personal-brand
  • Strict mode: If any entry has validation issues, abort the whole run without publishing anything. Use this in CI to make a bad file fail the pipeline. 
    $ sentilis sync ./examples/personal-brand --strict
  • Dry run: Validate everything without uploading. Combine with --strict to mirror the CI gate locally before committing. 
    $ sentilis sync ./examples/personal-brand --dry-run --strict

Exit codes are pipeline-friendly: 0 only when every requested step succeeded; 1 when a publish call fails, when --strict finds issues, or when nothing publishable was found.

Looking for ready-made starting points? Browse the Awesome Templates for Bio, Market & Press.

Stay in touch

Support

For issues and feature requests, please use the GitHub Issues page.

License

Sentilis CLI is MIT licensed. See the Contributing Guide for more details.