Quickstart

This page takes you from zero to a registered profile and a project with a generated AGENTS.md. Total time: about two minutes.

Using an AI coding agent? Click Copy AI agent setup prompt above and paste it into your agent to have it install agents-cli and load the acli skill automatically.

1. Install

The one-line installer downloads the latest release and drops the binary into /usr/local/bin (falling back to ~/.local/bin if the former isn't writable), plus an acli symlink as a shorter alias.

curl -fsSL https://acli.chagbrasil.com/install/install.sh | sh

Verify it landed:

agents-cli version

Prefer to build from source? Use go install gitlab.com/chagbrasil/agents-cli/cmd/agents-cli@latest. See the Usage guide for advanced options.

2. Register a profile

A profile is a git repository that carries the AGENTS.md template, Skills, MCP config and long-term-memory pointers. Clone and register one with install --profile:

agents-cli install --profile git@example.com:workspace/agents.git --name devops

install passes the URL verbatim to git clone, so your SSH agent and ~/.ssh/config handle authentication — no extra credential setup. The profile is cloned into the canonical tree at ~/.config/agents-cli/profiles/devops/ and pinned to the highest vX.Y.Z release tag (override with --version vX.Y.Z). If you omit --name, it's derived from the URL's last path segment.

List what you've registered:

agents-cli list --profile

Building your own profile? See Authoring a profile to start from the template repository and cut its first release.

3. Render AGENTS.md into a project

Move into a project and render the profile's AGENTS.md with install --project:

cd ~/Dev/scripts-devops
agents-cli install --project devops

This renders the profile's template into ./AGENTS.md (expanding {{AGENTS_PROFILE_HOME}} to the absolute profile directory), adds AGENTS.md to the project's .gitignore, and registers the binding. Re-running with a different profile rebinds the project.

See every project that has an installed AGENTS.md:

agents-cli list --project

4. Keep it up to date

Move the profile to its newest release tag, then re-render the projects bound to it:

agents-cli update --profile devops        # asks before moving; --yes to skip
agents-cli update --project --all          # re-render every project marked "stale"

5. Validate

When in doubt, run doctor in either mode:

agents-cli doctor --profile   # validate registered profiles (path, git repo)
agents-cli doctor --project   # validate projects with an installed AGENTS.md

Next steps

• Read the Usage guide for every subcommand and flag.
• Learn the Profiles model: what a profile carries and how projects bind to it.
• Browse the Commands & flags reference (mirrors the generated docs for the latest release).