CLI Reference

The engrammic CLI helps you install, configure, and manage Engrammic across different code editors and deployment modes.

Installation

curl -fsSL https://get.engrammic.ai | sh

This downloads the CLI binary for your platform and runs the interactive installer.

Commands

engrammic install

Configure Engrammic MCP for your code editors.

engrammic install [OPTIONS]

Options:

• -y, --yes - Skip prompts, auto-configure detected editors
• --tool <ID> - Configure a specific editor by ID

Supported editors:

• Claude Code (claude-code)
• Cursor (cursor)
• Windsurf (windsurf)
• VS Code + Continue (vscode-continue)
• Zed (zed)
• Codex CLI (codex)
• Goose (goose)

engrammic selfhost

Interactive wizard for self-hosted deployment.

engrammic selfhost

Guides you through:

1. Docker prerequisite check
2. License key validation
3. Port configuration (MCP server, Dagster UI)
4. LLM provider setup (OpenAI, Anthropic, Vertex AI)
5. Service startup
6. Editor configuration

engrammic status

Show current installation state.

engrammic status

Displays:

• Deployment mode (cloud or self-hosted)
• Configured editors
• License status (self-hosted)
• Service health (self-hosted)

engrammic upgrade

Upgrade self-hosted deployment to latest version.

engrammic upgrade

Actions:

1. Pulls latest container images
2. Restarts services with new images
3. Cleans up old images

engrammic doctor

Run diagnostic health checks.

engrammic doctor

Checks:

• Docker daemon running
• Container health status
• Service connectivity (memgraph, qdrant, redis, postgres)
• License validity

engrammic logs

View service logs for self-hosted deployment.

engrammic logs [OPTIONS]

Options:

• -s, --service <NAME> - Specific service (app, dagster, memgraph, etc.)
• -f, --follow - Follow log output
• -n, --lines <N> - Number of lines to show (default: 100)

Examples:

# Interactive service selection
engrammic logs

# Follow app logs
engrammic logs -s app -f

# Last 500 lines from dagster
engrammic logs -s dagster -n 500

engrammic scale

Show container resource usage and scaling recommendations.

engrammic scale

Displays memory usage per container and suggests resource adjustments.

engrammic license

View or update license key (self-hosted only).

engrammic license

Shows current license status and allows updating to a new key.

engrammic skills

Install or update Engrammic skills.

engrammic skills [OPTIONS]

Options:

• --skill-path <PATH> - Custom skill installation directory

engrammic uninstall

Remove Engrammic configuration from editors.

engrammic uninstall [OPTIONS]

Options:

• -y, --yes - Skip confirmation prompts
• --tool <ID> - Remove from specific editor only

engrammic list

List all detected code editors.

engrammic list

Shows which editors are installed and whether Engrammic is configured for each.

engrammic update

Update MCP endpoint configuration.

engrammic update [OPTIONS]

Refreshes the engrammic server entry in configured editors.

Global Options

These options work with any command:

• -y, --yes - Skip interactive prompts
• --tool <ID> - Target specific editor
• --skill-path <PATH> - Custom skill directory

Configuration Files

The CLI stores configuration in ~/.engrammic/:

~/.engrammic/
  config.json          # User preferences
  docker-compose.yml   # Self-hosted service definitions
  .env                 # Self-hosted environment variables

Exit Codes

Environment Variables

Examples

Fresh cloud setup

engrammic install
# Select "Cloud" mode
# Select editors to configure

Self-hosted setup

engrammic selfhost
# Follow the wizard

CI/CD automation

# Non-interactive cloud setup for Claude Code
engrammic install -y --tool claude-code

Check deployment health

engrammic doctor
engrammic status

Tail production logs

engrammic logs -s app -f