Skip to main content

Axiom: Your Coding Assistant

Project description

Axiom: AI-powered coding assistant

Your terminal, but with AI. Edit files, run commands, chat with AI - all in one session.

Install in 30 seconds

pip install axiomai-cli
axiomai chat

OR

git clone https://github.com/Mustafa-Kayra/axiom.git
cd axiom
# For Windows:
python -m venv .venv
.venv\Scripts\activate.bat
# For Linux: (bash)
python3 -m venv .venv
source .venv/bin/activate
pip install requirements.txt
pip install -e .
axiomai chat

What it does

$ axiomai chat
> fix the bug in server.py
✓ Fixed undefined variable on line 42

> vim server.py
[opens real vim, returns to chat after]

> refactor: make it async
✓ Updated server.py with async/await

> pytest
✗ Tests fail

> restore
✓ Reverted last changes

No copy-pasting. No context switching. AI edits your files directly.

Why developers love it

  • Zero config - Automatically reads your project files (respects .gitignore)
  • Instant undo - restore command reverts any AI changes immediately
  • Real shell - Run git, pytest, even vim without leaving the chat
  • 100% local backups - Your code is safe, changes stored in .aye/
  • No prefixes - Just type. Commands run, everything else goes to AI

Instant undo with Axiom's Restore

Axiom's restore command provides an instant and reliable safety net for any changes made by the AI. Developers can forge ahead and experiment knowing that application restore is just one simple command away.

Restore offers fine-grained control:

  • restore <ordinal>: Lets users revert to a specific historical snapshot (e.g., 001). This is useful for stepping back through multiple AI interactions.
  • restore <ordinal> <file>: Allows restoring a specific file from a particular snapshot. This is incredibly powerful for selectively reverting changes without affecting other files that might have been correctly updated.

Restore works best when used alongside other commands:

  • history: to view available snapshots
  • diff: to compare current files with previous versions

These commands provide a comprehensive system for reviewing, managing, and reverting code changes, keeping you in control.

Quick examples

# In your project directory:
Axiom

> refactor this to use dependency injection
> pytest
> fix what broke  
> git commit -m "refactored DI"

Get started

  1. Install: pip install axiomai-cli
  2. Start chatting: axiomai chat in any project folder

Starting a Session

Axiom                          # Start chat with auto-detected files
Axiom --root ./src             # Specify a different project root
Axiom --include "*.js,*.css"   # Manually specify which files to include

In-Chat Commands

Your input is handled in this order:

  1. Built-in Commands (like restore or model)
  2. Shell Commands (like ls -la or git status)
  3. AI Prompt (everything else)

Session & Model Control

  • new - Start a fresh chat session
  • model - Select a different AI model
  • verbose [on|off] - Toggle verbose output on or off
  • exit, quit, Ctrl+D - Exit the chat
  • help - Show available commands

Reviewing & Undoing AI Changes

  • restore, undo - Instantly undo the last set of changes made by AI
  • history - Show the history of changes made by AI
  • diff <file> - Compare current version against last change

Shell Commands

  • Run any command: ls -la, git status, docker ps
  • Interactive programs work: vim, nano, less, top
⚙️ Configuration & Privacy

Configuration

  • Axiom respects .gitignore and .ayeignore - private files are never touched
  • Change history and backups stored locally in .aye/ folder
  • Configure default model and preferences in ~/.ayecfg

Privacy & Security

  • All file backups are local only
  • API calls only include files you explicitly work with
  • No telemetry or usage tracking
  • Open source - audit the code yourself
🤖 AGENTS.md (repo instructions)

AGENTS.md inclusion

Axiom can automatically include AGENTS.md as extra system context for a repo — perfect for team conventions, architecture notes, and "how we do things here".

Discovery (first match wins):

  • ./.aye/AGENTS.md (highest precedence)
  • then walking up from the current directory: .aye/AGENTS.md or AGENTS.md

Tip: keep it short and actionable — it’s treated as instructions for the assistant.

See more details on https://agents.md/

🧩 Plugins & Extensions

Extensible via Plugins

The core experience is enhanced by plugins:

  • Shell execution plugin
  • Autocompletion plugin
  • Custom command plugins
  • Model provider plugins
🐧 NixOS/Nix Installation
# Run directly without installing
nix run github:acrotron/aye-chat

# Or install to your profile
nix profile install github:acrotron/aye-chat

Contributing

Axiom is open source! We welcome contributions.

License

MIT License - see LICENSE file

Disclaimer

review the DISCLAIMER before using this software.


Ready to code with AI without leaving your terminal?

pip install ayechat && Axiom

WikiDiscordGitHub

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

axiomai_cli-0.1.7.5.tar.gz (377.2 kB view details)

Uploaded Source

Built Distribution

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

axiomai_cli-0.1.7.5-py3-none-any.whl (200.2 kB view details)

Uploaded Python 3

File details

Details for the file axiomai_cli-0.1.7.5.tar.gz.

File metadata

  • Download URL: axiomai_cli-0.1.7.5.tar.gz
  • Upload date:
  • Size: 377.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.1

File hashes

Hashes for axiomai_cli-0.1.7.5.tar.gz
Algorithm Hash digest
SHA256 e2b92d6281fc15ea5d19fad42b2a86e0fdb1dc112bd2e6eb63142f6556522c04
MD5 6a28557db9fcb6c25c67051270e46f27
BLAKE2b-256 27b2fece4f93fa573d0eaad225df2bb63df5c0f52f80020708b07a357fb36e52

See more details on using hashes here.

File details

Details for the file axiomai_cli-0.1.7.5-py3-none-any.whl.

File metadata

  • Download URL: axiomai_cli-0.1.7.5-py3-none-any.whl
  • Upload date:
  • Size: 200.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.1

File hashes

Hashes for axiomai_cli-0.1.7.5-py3-none-any.whl
Algorithm Hash digest
SHA256 e36716bfa605cc78e051309ff5f73f63f3b7734271116429f7ae9b2f372c8d31
MD5 c04968195416885523ed343c5e183865
BLAKE2b-256 8ce959da98fde57799b21e430d6c1f0ec2888d0cb6c1e97507f4c470604789ea

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