Skip to content

claude-code-cli.md

Latest commit

 

History

History
106 lines (68 loc) · 2.82 KB

claude-code-cli.md

File metadata and controls

106 lines (68 loc) · 2.82 KB
Raw

Install agami in Claude Code CLI

This is the simplest path. Most agami users start here.

1. Install Claude Code

If you don't have Claude Code yet:

# macOS / Linux
curl -fsSL https://claude.com/install.sh | sh

# Windows (PowerShell, in an elevated session)
irm https://claude.com/install.ps1 | iex

Then sign in:

claude login

2. Open Claude Code

In any terminal:

claude

You should see the Claude Code prompt.

3. Add the agami marketplace

/plugin marketplace add AgamiAI/agami-core

Expected output:

Added marketplace: agami (AgamiAI)
1 plugin available: agami-core

4. Install the agami plugin

/plugin install agami-core@agami

Expected output:

Installed agami-core v0.3.3 (from agami)
7 skills available: agami-connect, agami-query, agami-model, agami-save-correction, agami-reconcile, agami-serve, agami-deploy

agami-deploy (the self-hosted team server) is early access — in testing: usable today, but newer than the local single-player skills. See its early-access note.

5. Verify

/plugin list

You should see agami-core v0.3.3 in the active list.

Try invoking it:

/agami-connect

On first run, the skill sees there are no credentials, walks you through the DB-type picker, and writes a <artifacts_dir>/local/credentials.example template for you to fill in. (There's no separate /agami-init — setup lives inside /agami-connect.)

6. Set up credentials

/agami-connect writes a template at <artifacts_dir>/local/credentials.example the first time you connect. Fill in your connection details, save it (leave the filename as-is), then say "introspect my database" — agami moves it into place and locks it down (chmod 600) for you; you don't move or chmod anything by hand. Full format and per-database fields: docs/credentials.md.

Updating

/plugin update agami-core@agami

Uninstalling

/plugin uninstall agami-core
/plugin marketplace remove agami

Your <artifacts_dir>/local/ directory and its contents are not touched by uninstall — delete it manually if you want to clean up.

Troubleshooting

Symptom Fix
/plugin: command not found Update Claude Code: claude update
Failed to fetch marketplace Check your network; the marketplace lives on GitHub
Plugin not authorized Run claude login again
Skill doesn't appear in autocomplete after install Restart Claude Code (/exit then claude again)