Skip to main content

Getting Started

Install and set up the Sentrix CLI in your repository.

Getting Started

This guide walks you through installing the Sentrix CLI, setting up your repository, and running your first workflow.

Installation#

Install the sentrix binary using Cargo:

bash
cargo install sentrix

Verify the installation:

bash
sentrix --version

Repository Setup#

Run sentrix init in the root of your repository to configure Sentrix:

bash
sentrix init

This command does four things:

  1. Creates .sentrix/config.toml — Repository-level configuration with your API URL and platform mappings. This file is committed to source control.
  2. Creates ~/.sentrix/config.toml — User-level configuration with your API key, name, and email. This file is local to your machine and should never be committed.
  3. Installs 16 Claude Code commands to .claude/commands/ — AI-powered slash commands for requirements, plans, and implementations.
  4. Updates .gitignore — Appends .sentrix/plan-index.json to prevent the local index from being committed.

Interactive Prompts#

During setup, you are prompted for:

  • API URL — The Sentrix API endpoint (default: https://api.sentrix.ai)
  • API key — Your authentication key (entered as hidden input)
  • Name — Your display name for plan authorship
  • Email — Your email address for plan authorship
  • Platform mappings — Which platform each app in your plans/ directory uses (e.g., nextjs, fastapi, rust-cli, ui-component)
  • Architecture doc paths — Documentation files that guide AI-generated plans for each platform

Validating Your Setup#

To verify an existing setup without modifying anything, use the --check flag:

bash
sentrix init --check

This runs a series of checks and reports pass/fail/warn for each:

  • Config files exist and have valid schemas
  • API URL and key are configured
  • Platform mappings are present
  • Claude Code command files are installed
  • .gitignore includes the plan index

Verify Authentication#

After setup, confirm that your API key works and the CLI can reach the Sentrix API:

bash
sentrix auth test

A successful response confirms you are authenticated. Add --verbose to see the request URL and response time:

bash
sentrix auth test --verbose

Quick Walkthrough#

Here is a minimal end-to-end workflow from initiative to implementation:

1. Create an Initiative#

An initiative is a high-level goal that groups related requirements:

bash
sentrix initiative new --description "Add user onboarding flow with guided tour and progress tracking"

2. Generate Requirements#

Create a detailed requirements document for a specific app:

bash
sentrix requirements new --app website --description "Guided tour component that highlights key features on first login"

3. Generate Plans#

Break the requirements into actionable implementation plans:

bash
sentrix plan generate plans/website/2026-02/feature-guided-tour/

4. Review a Plan#

Have the AI review a plan for completeness, consistency, and correctness:

bash
sentrix plan review plans/website/2026-02/feature-guided-tour/01-feature-guided-tour-component.md

5. Implement a Plan#

Have the AI implement the plan, including writing code, tests, and running verification:

bash
sentrix plan implement plans/website/2026-02/feature-guided-tour/01-feature-guided-tour-component.md

Each command builds on the previous one, creating a structured workflow from idea to implementation.