Mycelos logo mycelos

CLI Reference

In the Docker deployment (the default since v0.3), the ~/.local/bin/mycelos wrapper installed by scripts/install.sh is the CLI entry point. Most subcommands forward into the gateway container; a handful of stack-level operations run on the host.

Host-side subcommands

These run outside the container. They manage the stack itself and have no equivalent inside the gateway process.

CommandDescription
mycelos updatedocker compose pull + up -d. Pulls the latest image and restarts the stack. Idempotent.
mycelos restart [service]Restart both containers, or just gateway / proxy.
mycelos logs [service] [-f]Follow the gateway + proxy logs (or a single service).
mycelos shellDrop into a bash shell inside the gateway container — useful for debugging.
mycelos stopStop the stack (docker compose stop).

In-container subcommands

These forward to mycelos inside the gateway, which resolves --data-dir from MYCELOS_DATA_DIR=/data — no flag needed from you.

CommandDescription
mycelos doctorHealth check across storage, credentials, channels, schedules, and available updates.
mycelos doctor --whyLLM-powered interactive diagnosis.
mycelos doctor --check <area>Focused check: storage, credentials, telegram, reminders, schedules, update, organizer.
mycelos config listList all NixOS-style config generations.
mycelos config show [N]Inspect a generation.
mycelos config diff A BDiff two generations.
mycelos config rollback [N]Roll back to generation N.
mycelos credential listList encrypted credentials (metadata only — never plaintext).
mycelos credential store <service> <key>Encrypt and store a credential via the proxy.
mycelos credential delete <service>Remove a credential.
mycelos connector add <name>Register an MCP connector.
mycelos connector listShow active connectors.
mycelos model listList registered LLM models.
mycelos model test <id>Verify a model responds.
mycelos schedule listShow scheduled workflow tasks (cron).
mycelos sessions listList chat sessions.
mycelos chatInteractive chat session in the terminal.

mycelos demo, mycelos init, and mycelos serve exist but are primarily for the dev/source-install path; in the Docker deployment the containers call them for you during startup.

Tab completion

scripts/install.sh installs static tab-completion for bash, zsh, and fish at install time — no runtime overhead. Completion covers the full command tree including the host-side shortcuts above. Refresh happens automatically the next time you re-run the installer.

Running the CLI outside the wrapper

If you need to call the CLI from a script without the wrapper, use the compose exec form:

docker compose -f ~/mycelos-new/docker-compose.yml exec gateway mycelos doctor

The mycelos wrapper is just a thin shell script around that command with host-side shortcuts bolted on; you can read it at ~/.local/bin/mycelos.

Source-install mode

When you install from source (pip install -e .), there is no wrapper and no container: mycelos <subcommand> invokes the Click entry point directly, and --data-dir falls back to ~/.mycelos/. The in-container subcommands above still apply, but update / restart / logs / shell / stop are meaningless and not defined.