254 lines
6.6 KiB
Groff
254 lines
6.6 KiB
Groff
.ie \n(.g .ds Aq \(aq
|
|
.el .ds Aq '
|
|
.TH am 1 "am 1.1.9"
|
|
.SH NAME
|
|
am \- agent\-manager (am) — manage local AI coding agents
|
|
.SH SYNOPSIS
|
|
\fBam\fR [\fB\-c\fR|\fB\-\-config\fR] [\fB\-v\fR|\fB\-\-verbose\fR] [\fB\-q\fR|\fB\-\-quiet\fR] [\fB\-y\fR|\fB\-\-yes\fR] [\fB\-\-dry\-run\fR] [\fB\-\-json\fR] [\fB\-\-no\-color\fR] [\fB\-\-theme\fR] [\fB\-\-lang\fR] [\fB\-h\fR|\fB\-\-help\fR] [\fB\-V\fR|\fB\-\-version\fR] [\fIsubcommands\fR]
|
|
.SH DESCRIPTION
|
|
agent\-manager (am) — a CLI to manage local AI coding agents.
|
|
.PP
|
|
Install, uninstall, start, stop, restart and update AI agents from a YAML
|
|
catalog. Handles dependencies (Node, Python, Go, Rust, Bun), binaries from
|
|
GitHub Releases, install scripts, and git repositories. All state lives under
|
|
your user directories; nothing pollutes the system.
|
|
.SH OPTIONS
|
|
.TP
|
|
\fB\-c\fR, \fB\-\-config\fR \fI<FILE>\fR
|
|
Use an alternate configuration file
|
|
.TP
|
|
\fB\-v\fR, \fB\-\-verbose\fR
|
|
Verbose output: show every command executed and its details
|
|
.TP
|
|
\fB\-q\fR, \fB\-\-quiet\fR
|
|
Quiet mode: only errors are printed
|
|
.TP
|
|
\fB\-y\fR, \fB\-\-yes\fR
|
|
Answer yes to every confirmation prompt
|
|
.TP
|
|
\fB\-\-dry\-run\fR
|
|
Simulate the action without changing anything
|
|
.TP
|
|
\fB\-\-json\fR
|
|
Emit machine\-readable JSON on stdout (for scripts)
|
|
.TP
|
|
\fB\-\-no\-color\fR
|
|
Disable ANSI colors
|
|
.TP
|
|
\fB\-\-theme\fR \fI<THEME>\fR
|
|
Color theme for the output (see \*(Aqam help theme\*(Aq for the list)
|
|
.TP
|
|
\fB\-\-lang\fR \fI<LANG>\fR
|
|
Output language: fr (default) or en (issue #74)
|
|
.br
|
|
|
|
.br
|
|
\fIPossible values:\fR
|
|
.RS 14
|
|
.IP \(bu 2
|
|
fr
|
|
.IP \(bu 2
|
|
en
|
|
.RE
|
|
.TP
|
|
\fB\-h\fR, \fB\-\-help\fR
|
|
Print help (see a summary with \*(Aq\-h\*(Aq)
|
|
.TP
|
|
\fB\-V\fR, \fB\-\-version\fR
|
|
Print version
|
|
.SH SUBCOMMANDS
|
|
.TP
|
|
am\-list(1)
|
|
List installed agents (default); use \-\-all for the whole catalog
|
|
.TP
|
|
am\-logs(1)
|
|
Tail the log file of an agent (\-\-follow for a live view)
|
|
.TP
|
|
am\-open(1)
|
|
Open an agent\*(Aqs installation directory in the file manager
|
|
.TP
|
|
am\-watch(1)
|
|
Supervise an agent and optionally restart it on crash
|
|
.TP
|
|
am\-dashboard(1)
|
|
Live TUI dashboard: overview, activity, stats, sessions, projects
|
|
.TP
|
|
am\-favorite(1)
|
|
Mark an agent as a favorite (star in list and status)
|
|
.TP
|
|
am\-unfavorite(1)
|
|
Remove the favorite star from an agent
|
|
.TP
|
|
am\-note(1)
|
|
Attach a free\-form note to an agent (shown in \*(Aqam info\*(Aq); \*(Aqam note <agent>\*(Aq without text prints the current note
|
|
.TP
|
|
am\-tag(1)
|
|
Add a personal tag to an agent
|
|
.TP
|
|
am\-untag(1)
|
|
Remove a personal tag from an agent
|
|
.TP
|
|
am\-tags(1)
|
|
List personal tags (with counts), optionally for one agent
|
|
.TP
|
|
am\-profile(1)
|
|
Manage environment profiles (dev, prod, ...)
|
|
.TP
|
|
am\-man(1)
|
|
Generate a man page for am (or for one command)
|
|
.TP
|
|
am\-theme(1)
|
|
Set or show the active color theme (persisted for the next run)
|
|
.TP
|
|
am\-alias(1)
|
|
Manage command aliases (cc \-> claude\-code)
|
|
.TP
|
|
am\-secret(1)
|
|
Manage secrets in the OS keyring (never in plaintext config)
|
|
.TP
|
|
am\-audit(1)
|
|
Audit the configuration: who changed what, when (issue #63)
|
|
.TP
|
|
am\-service(1)
|
|
Register an agent as a system service (issue #55)
|
|
.TP
|
|
am\-schedule(1)
|
|
Schedule am commands (issue #56)
|
|
.TP
|
|
am\-models(1)
|
|
List local models (ollama, llama.cpp, LM Studio) and prune unused ones
|
|
.TP
|
|
am\-registry(1)
|
|
Community registry (issue #77): publish, search and install agent catalogs hosted on Gitea
|
|
.TP
|
|
am\-catalog(1)
|
|
Manage remote catalogs: update the official one, add external ones
|
|
.TP
|
|
am\-providers(1)
|
|
Manage the LLM provider registry: base URLs, models, default provider
|
|
.TP
|
|
am\-suggest(1)
|
|
Suggest agents matching a query, boosted by real usage (issue #61)
|
|
.TP
|
|
am\-ask(1)
|
|
Ask a natural\-language request and get the matching am command(s) (issue #78): local rules first, optional LLM refinement, confirmation before execution
|
|
.TP
|
|
am\-ai(1)
|
|
Langage naturel → action shell via AIChat (issues #96 #97); alias: shell
|
|
.TP
|
|
am\-setup(1)
|
|
Onboarding wizard: provider, token, modèle par défaut, aichat, rôles copilot (épique v1.1.0)
|
|
.TP
|
|
am\-start(1)
|
|
Start an agent (foreground by default, or detached with \-\-background)
|
|
.TP
|
|
am\-stop(1)
|
|
Stop a background agent (SIGTERM, then SIGKILL after the timeout)
|
|
.TP
|
|
am\-restart(1)
|
|
Restart an agent: stop, then start with the same options
|
|
.TP
|
|
am\-status(1)
|
|
Show the state of one agent, or of every installed agent
|
|
.TP
|
|
am\-sessions(1)
|
|
List the sessions of every agent (and of the interactive shell)
|
|
.TP
|
|
am\-stats(1)
|
|
Show usage statistics computed from the event journal
|
|
.TP
|
|
am\-monitor(1)
|
|
Real\-time monitor of the managed processes (issue #50)
|
|
.TP
|
|
am\-web(1)
|
|
Local read\-only web dashboard with charts (issue #54)
|
|
.TP
|
|
am\-serve(1)
|
|
Authenticated HTTP + WebSocket API to drive am remotely (issue #80)
|
|
.TP
|
|
am\-sync(1)
|
|
Push the state into the configured git repository (issue #66)
|
|
.TP
|
|
am\-migrate(1)
|
|
Transfer the installation and state to another machine (issue #68)
|
|
.TP
|
|
am\-top(1)
|
|
Show the most used agents (top 10)
|
|
.TP
|
|
am\-report(1)
|
|
Write a markdown activity report
|
|
.TP
|
|
am\-projects(1)
|
|
Show which agent works on which project
|
|
.TP
|
|
am\-timeline(1)
|
|
One chronological view of every activity (journal + REPL history)
|
|
.TP
|
|
am\-log(1)
|
|
Read the event journal: everything am did
|
|
.TP
|
|
am\-install(1)
|
|
Install an agent and its dependencies
|
|
.TP
|
|
am\-uninstall(1)
|
|
Uninstall an agent (managed or external) and clean its files
|
|
.TP
|
|
am\-update(1)
|
|
Update an installed agent to the latest available version
|
|
.TP
|
|
am\-search(1)
|
|
Search the catalog by keyword (name, description, category, tags)
|
|
.TP
|
|
am\-history(1)
|
|
Search the command history (am and shell commands)
|
|
.TP
|
|
am\-playbook(1)
|
|
Replay a saved playbook step by step with confirmation (issue #51)
|
|
.TP
|
|
am\-lab(1)
|
|
Benchmark: run the same task on several agents and compare (issue #62)
|
|
.TP
|
|
am\-plugins(1)
|
|
List the event plugins and test one (issue #75)
|
|
.TP
|
|
am\-info(1)
|
|
Show detailed information about one agent
|
|
.TP
|
|
am\-init(1)
|
|
Generate a local agent\-manager.yaml for the current directory
|
|
.TP
|
|
am\-help(1)
|
|
Display help: the overview, a command, the command list, or a search
|
|
.TP
|
|
am\-version(1)
|
|
Display version and build information
|
|
.TP
|
|
am\-tip(1)
|
|
Cheat sheet: the most useful commands, their key options, your most\-used commands and a rotating tip of the day
|
|
.TP
|
|
am\-config(1)
|
|
Manage the configuration file
|
|
.TP
|
|
am\-doctor(1)
|
|
Check the environment: tools, config validity, paths, permissions
|
|
.TP
|
|
am\-run(1)
|
|
Run the agent command directly with the given arguments (no process management)
|
|
.TP
|
|
am\-completion(1)
|
|
Generate a shell completion script
|
|
.TP
|
|
am\-self\-update(1)
|
|
Update agent\-manager itself from the latest release
|
|
.TP
|
|
am\-self\-uninstall(1)
|
|
Remove agent\-manager and everything it created from this machine
|
|
.TP
|
|
am\-export(1)
|
|
Export the configuration and installation state (backup)
|
|
.TP
|
|
am\-import(1)
|
|
Import a previously exported configuration and state
|
|
.SH VERSION
|
|
v1.1.9
|