Skip to main content

A terminal coding agent for Python.

Project description

Katalyst Agent

A modular, node-based terminal coding agent for Python, designed for robust, extensible, and production-ready workflows.

Quick Setup

To install all dependencies, simply run:

poetry install

Important: You must set your OpenAI API key as the environment variable OPENAI_API_KEY or add it to a .env file in your project directory. The first time you run katalyst, you will be prompted to enter your API key if it is missing. You can get an API key from https://platform.openai.com/account/api-keys.

Searching Files (ripgrep required)

The search_files tool requires ripgrep (rg) to be installed on your system:

  • macOS: brew install ripgrep
  • Ubuntu: sudo apt-get install ripgrep
  • Windows: choco install ripgrep

Features

  • Automatic project state persistence: Katalyst saves your project state (such as chat history) to .katalyst_state.json in your project directory after every command. This happens in the background—no user action required. When you return to your project, your session context is automatically restored.

TODO

See TODO.md for the latest development tasks and roadmap.

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

katalyst-0.1.1.tar.gz (33.5 kB view details)

Uploaded Source

Built Distribution

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

katalyst-0.1.1-py3-none-any.whl (48.2 kB view details)

Uploaded Python 3

File details

Details for the file katalyst-0.1.1.tar.gz.

File metadata

  • Download URL: katalyst-0.1.1.tar.gz
  • Upload date:
  • Size: 33.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for katalyst-0.1.1.tar.gz
Algorithm Hash digest
SHA256 92be03f34e58dcb0c67eda079256a2aa83c264e42fbb4a29fccb70bd102e7a3a
MD5 a63bc67e57e92046bf98d84c96a67c53
BLAKE2b-256 2290c83f95ee559b64ce72a9f8c9c12d6a75814d1c243acb6532024d1278f7cb

See more details on using hashes here.

File details

Details for the file katalyst-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: katalyst-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 48.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for katalyst-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 d27c14bb1d6a7b48f20c26c1feaebf170e2dd4161f37fccb2a4e0ff3477769cd
MD5 bad8e6e3dcb2f0821d4cab92880bd323
BLAKE2b-256 0b51ad618d01ca0f7bf62ce3d1374e5e3406136a4c58670a95e1b8cdb005d7fd

See more details on using hashes here.

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