CLI Reference
The Almirant CLI lets you connect repositories to projects, authenticate, and configure the MCP integration from the terminal.
Installation
npm i -g almirant
Verify the installation:
almirant --version
Commands
| Command | Description |
|---|---|
almirant login | Authenticate via browser and store the API key in ~/.almirant/config.json |
almirant link | Link the current repository to a project using stored credentials |
almirant init | Configure Almirant MCP for the current project (complete flow) |
Global flags
| Flag | Description |
|---|---|
--version, -v | Show the CLI version |
--help, -h | Show help with available commands |
Generated files
The CLI creates and uses the following files:
| File | Location | Description |
|---|---|---|
config.json | ~/.almirant/config.json | Authentication credentials (API key, URL, user) |
.mcp.json | Repository root | MCP configuration to connect the agent to the project |
.agents/skills/ | Repository root | Skill templates copied for agent use |
info
The ~/.almirant/config.json file has 600 permissions (read/write only for the user). Never share this file.
Recommended flow
For most users, the recommended flow is:
# 1. Authenticate (once)
almirant login
# 2. In each repository, link to the project
cd your-repository
almirant link
If you prefer an all-in-one flow that includes authentication and configuration, use almirant init.