Skip to main content

djinn-bot-cli

CLI for the DjinnBot agent orchestration platform. Set up DjinnBot, authenticate, chat with agents, manage pipelines, configure model providers, and browse agent memory — all from the terminal.

Installation

pip install djinn-bot-cli

Or with uv:

uv tool install djinn-bot-cli

Or with pipx:

pipx install djinn-bot-cli

The one-line installer also installs the CLI automatically.

Quick Start

# First-time setup (interactive wizard)
djinn setup

# Log in to the server
djinn login

# Check server connectivity
djinn status

# Chat with an agent (interactive picker for agent + model)
djinn chat

# Chat directly
djinn chat --agent stas --model anthropic/claude-sonnet-4

# Configure a model provider API key
djinn provider set-key anthropic

Commands

djinn setup

Interactive setup wizard for first-time installation. Handles cloning the repo, generating secrets, configuring a model provider, optional SSL/TLS with Traefik, and starting the Docker stack. Safe to re-run.

djinn setup                         # interactive setup
djinn setup --dir /opt/djinnbot     # specify install directory
djinn setup --no-ssl                # skip SSL prompt
djinn setup --no-provider           # skip provider prompt

djinn login / djinn logout / djinn whoami

Authentication commands for servers with AUTH_ENABLED=true.

djinn login                         # interactive email/password + optional 2FA
djinn login --api-key <key>         # login with an API key
djinn whoami                        # show current user info
djinn logout                        # clear credentials and invalidate session

Credentials are stored per server URL in ~/.config/djinnbot/auth.json. JWT tokens are automatically refreshed when expired.

Authentication resolution order: --api-key flag > DJINNBOT_API_KEY env var > stored credentials.

djinn status

Show server health, Redis connection, active runs, and GitHub App status.

djinn chat

Interactive TUI chat session with an agent. Features streaming responses with markdown rendering, collapsible thinking blocks and tool calls with syntax-highlighted JSON, and a fuzzy-search model picker.

djinn chat                          # interactive agent + model selection
djinn chat -a finn -m anthropic/claude-sonnet-4  # skip pickers

djinn provider

Manage model provider API keys and configuration.

djinn provider list                 # show all providers and status
djinn provider show anthropic       # details + available models
djinn provider set-key openrouter   # set API key (secure prompt)
djinn provider models               # list models from configured providers
djinn provider enable openai        # enable a provider
djinn provider disable openai       # disable (keeps key)
djinn provider remove openai        # delete key and config

djinn pipeline

Manage pipeline definitions.

djinn pipeline list                 # list all pipelines
djinn pipeline show engineering     # show steps and agents
djinn pipeline validate engineering # validate a pipeline
djinn pipeline raw engineering      # show raw YAML

djinn agent

Manage agents and view their status.

djinn agent list                    # list all agents
djinn agent show stas               # detailed info + persona files
djinn agent status                  # fleet overview
djinn agent status stas             # single agent status
djinn agent runs stas               # run history
djinn agent config stas             # agent configuration
djinn agent projects stas           # assigned projects

djinn memory

Browse and search agent memory vaults.

djinn memory vaults                 # list all vaults
djinn memory list stas              # files in a vault
djinn memory show stas session.md   # view a file
djinn memory search "deployments"   # search across vaults
djinn memory search "arch" -a finn  # search within an agent
djinn memory delete stas old.md     # delete a file

Configuration

The CLI connects to http://localhost:8000 by default. Override with:

djinn --url http://your-server:8000 status

Or set the environment variable:

export DJINNBOT_URL=http://your-server:8000

Development

cd cli
uv sync --all-extras
uv run djinn --help
uv run pytest tests/ -v

Metadata

Release files for djinn-bot-cli 0.4.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for djinn-bot-cli 0.4.0
File Size Uploaded
djinn_bot_cli-0.4.0.tar.gz 74.2 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for djinn-bot-cli 0.4.0
File Interpreter ABI Platform
djinn_bot_cli-0.4.0-py3-none-any.whl Python 3 none any Details

Total release size: 130.9 kB

Release files / djinn_bot_cli-0.4.0.tar.gz

Download URL djinn_bot_cli-0.4.0.tar.gz
Size 74.2 kB
Tags Source
SHA-256 checksum
How to use checksums
9183d2603d121a9268f44ec9478125141afecfd307ddccb5c3b8984051df4844
BLAKE2b-256 checksum
How to use checksums
07d8354476a7221f3be99a48649d9c22a0625fc9dfb1c66a013867d81eb226ea
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.13.7

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Feb 28, 2026.

Transparency log

Release files / djinn_bot_cli-0.4.0-py3-none-any.whl

Download URL djinn_bot_cli-0.4.0-py3-none-any.whl
Size 56.8 kB
Tags Python 3
SHA-256 checksum
How to use checksums
2cc55aa28c7f3d8cb72baa4c06985f12c25e8cedd8d0c6445a0d2d20856722a5
BLAKE2b-256 checksum
How to use checksums
8134e2fa06c1462568f5faeb8828cd33702c19a530f8264ff34d753b043b5585
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.13.7

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Feb 28, 2026.

Transparency log

Release history Release notifications | RSS feed

This release

0.4.0 This release

2 release files

0.3.0

2 release files

0.2.11

2 release files

0.2.9

2 release files

0.2.7

2 release files

0.2.6

2 release files

0.2.5

2 release files

0.2.4

2 release files

0.2.3

2 release files

0.2.2

2 release files

0.2.0

2 release files

0.1.3

2 release files

0.1.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page