Skip to main content

Python CLI for djinnbot

Project description

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

djinn_bot_cli-0.2.0.tar.gz (58.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

djinn_bot_cli-0.2.0-py3-none-any.whl (38.6 kB view details)

Uploaded Python 3

File details

Details for the file djinn_bot_cli-0.2.0.tar.gz.

File metadata

  • Download URL: djinn_bot_cli-0.2.0.tar.gz
  • Upload date:
  • Size: 58.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for djinn_bot_cli-0.2.0.tar.gz
Algorithm Hash digest
SHA256 837f354d457ca46081905ec39430f5cab28cb2bd2a8dfd8fb205df17f3c89816
MD5 69aa900fdf37278f7824e5bcaaa619bd
BLAKE2b-256 dcd98ecdc1b3740ec1716aa89e87e161caeb605f85fe46fc5c54a11006d6bf68

See more details on using hashes here.

Provenance

The following attestation bundles were made for djinn_bot_cli-0.2.0.tar.gz:

Publisher: cli-publish.yml on BaseDatum/DjinnBot

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file djinn_bot_cli-0.2.0-py3-none-any.whl.

File metadata

  • Download URL: djinn_bot_cli-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 38.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for djinn_bot_cli-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 cad444205df6b28d69558f8f3232d2f5c0370f38a0d0e410b15ef71e12e0d5c7
MD5 b9f5089da8781a6ae0f311d48887a2c0
BLAKE2b-256 d23edd38f659d97427720fbfe13c0cf38b0cf41813ed90b0d78bdb417db47a83

See more details on using hashes here.

Provenance

The following attestation bundles were made for djinn_bot_cli-0.2.0-py3-none-any.whl:

Publisher: cli-publish.yml on BaseDatum/DjinnBot

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page