Skip to main content

Token — a colorful CLI coding agent with file tools, shell execution, and swappable LLM providers

Project description

Token

PyPI version Python

A colorful CLI coding agent built in Python. It reads and writes files, searches code, runs shell commands, and chats with you via OpenAI — all from your terminal with a Rich-powered UI.

Install

Recommended — isolated CLI install with pipx:

pipx install excergic-token

Or with pip:

pip install excergic-token

Or with uv:

uv tool install excergic-token

Requires Python 3.11+.

Quick start

# Set your OpenAI API key
export OPENAI_API_KEY=sk-your-key-here

# Start the agent in your project directory
token chat --workspace .

You can also create a .env file in your project:

OPENAI_API_KEY=sk-your-key-here
OPENAI_MODEL=gpt-4o

Usage

# Interactive chat (default)
token
token chat

# Options
token chat --model gpt-4o-mini --workspace /path/to/project

# Version
token version

Features

  • File tools — read, write, create, list directories, regex search
  • Shell execution — run commands in your workspace (with permission)
  • Human-in-the-loop — destructive actions require explicit approval (y / a / n)
  • Workspace sandbox — all paths confined to a configurable root
  • Swappable LLM — provider abstraction with OpenAI as the default
  • Colorful UI — Rich panels, markdown, syntax highlighting, spinners

Slash commands

Command Description
/help Show help
/clear Clear conversation history
/exit Quit

Permission prompts

When the agent wants to write a file or run a shell command, you'll see a preview and be asked:

  • y — allow once
  • a — allow all for this session
  • n — deny

Configuration

Environment variables (via .env or shell):

Variable Default Description
OPENAI_API_KEY Your OpenAI API key
OPENAI_MODEL gpt-4o Model to use
LLM_PROVIDER openai LLM provider (extensible)
WORKSPACE_ROOT . Sandbox workspace root

Development

git clone https://github.com/Excergic/Token.git
cd Token
uv sync
cp .env.example .env   # add your API key
uv run token chat --workspace .

Publishing (maintainers)

Releases are published to PyPI as excergic-token via GitHub Actions when a GitHub Release is published.

  1. Configure PyPI Trusted Publishing for excergic-token → GitHub Excergic/Token
  2. Create a GitHub environment named pypi in repo settings
  3. Tag and release:
git tag v0.1.0
git push origin v0.1.0
# Create a GitHub Release from the tag — CI publishes automatically

Manual publish:

uv build
UV_PUBLISH_TOKEN=pypi-... uv publish

License

MIT

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

excergic_token-0.1.0.tar.gz (12.5 kB view details)

Uploaded Source

Built Distribution

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

excergic_token-0.1.0-py3-none-any.whl (21.6 kB view details)

Uploaded Python 3

File details

Details for the file excergic_token-0.1.0.tar.gz.

File metadata

  • Download URL: excergic_token-0.1.0.tar.gz
  • Upload date:
  • Size: 12.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for excergic_token-0.1.0.tar.gz
Algorithm Hash digest
SHA256 9aa6a3031746101834a5e44f207deb366e9ca3fab732b384e24f227ebd647f2d
MD5 cdb72e5f648bbebcda934a7c5b9bd176
BLAKE2b-256 a379010cb070b225bbf6e7a7149d92cde8af1fd8d34d349476387245602bb92c

See more details on using hashes here.

Provenance

The following attestation bundles were made for excergic_token-0.1.0.tar.gz:

Publisher: publish.yml on Excergic/Token

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

File details

Details for the file excergic_token-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: excergic_token-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 21.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for excergic_token-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 c97152ecbfad9272bdb7395ad9276b02555c7da2dabca8863589aff3cc6e968d
MD5 a92aa219d4e483f6b372f9a6a21f82e2
BLAKE2b-256 d7b1bbeac550ffe04f5331e41f897f57421da834c8f5184ed9595ca96556ef40

See more details on using hashes here.

Provenance

The following attestation bundles were made for excergic_token-0.1.0-py3-none-any.whl:

Publisher: publish.yml on Excergic/Token

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