Install the CLI

The Almirant CLI lets you connect any repository to your project with a couple of commands. It automates the creation of the .mcp.json file, copies skill templates, and sets up authentication without manually copying and pasting keys.

Requirements

• Node.js 18+ installed
• An Almirant account -- Create account
• A project created -- Your first project

Step 1: Install the CLI

Install the CLI globally:

npm i -g almirant

Verify the installation was successful:

almirant --version

Step 2: Sign in

Authenticate your account via browser:

almirant login

This command will open your browser to complete the OAuth flow. Once finished, your API key will be securely stored in ~/.almirant/config.json.

info

You only need to log in once. Credentials are automatically reused across all your projects.

Step 3: Link your repository

Navigate to the root of your repository and run:

almirant link

The CLI will:

1. Use the credentials stored in the previous step
2. Show your projects for you to select one
3. Generate the .mcp.json file with the correct configuration
4. Copy skill templates to .agents/skills/
5. Optionally configure your shell (PATH)

info

If you prefer a complete flow without having run almirant login first, use almirant init instead. This command guides you step by step through authentication and configuration in a single flow.

Step 4: Verify the connection

Open Claude Code in the project directory and ask:

> List my Almirant work items

If everything is configured correctly, Claude will respond with your project's work items.

Next step

Your repository is now connected. Continue with Your first AI flow to implement a complete task using AI from your IDE.

---

For more detail on each command, see the CLI Reference.