Skip to main content

Axiom is best coding assistant for you.

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:
axiomai chat

> 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

axiomai chat                          # Start chat with auto-detected files
axiomai chat --root ./src             # Specify a different project root
axiomai chat --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:Mustafa-Kayra/Axiom

# Or install to your profile
nix profile install github:Mustafa-Kayra/Axiom

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

Release files for axiomai-cli 0.1.8.2

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

Source distribution (sdist)

Source distribution for axiomai-cli 0.1.8.2
File Size Uploaded
axiomai_cli-0.1.8.2.tar.gz 393.8 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for axiomai-cli 0.1.8.2
File Interpreter ABI Platform
axiomai_cli-0.1.8.2-py3-none-any.whl Python 3 none any Details

Total release size: 594.4 kB

Release files / axiomai_cli-0.1.8.2.tar.gz

Download URL axiomai_cli-0.1.8.2.tar.gz
Size 393.8 kB
Tags Source
SHA-256 checksum
How to use checksums
0adff8f4e14eeffd0200ee7e12781e2978f4b85372a551b2a5208f4c472c0893
BLAKE2b-256 checksum
How to use checksums
d707a469907cc6def999cac5b5f5de755c92c5f6a71154e2afeb7ba571afd578
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.12.1

Release files / axiomai_cli-0.1.8.2-py3-none-any.whl

Download URL axiomai_cli-0.1.8.2-py3-none-any.whl
Size 200.6 kB
Tags Python 3
SHA-256 checksum
How to use checksums
d8f63c40a32df329001b0048baa31eb990c2b0fe9c050bb93bda53239f3e9e5e
BLAKE2b-256 checksum
How to use checksums
4c34ae3ad5e6be57266c2604c66faf5a6132fe4d6b08537d6879a666da38d29a
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.12.1

Release history Release notifications | RSS feed

This release

0.1.8.2 This release

2 release files

0.1.8

2 release files

0.1.7

2 release files

0.1.6

2 release files

0.1.5

2 release files

0.1.4

2 release files

0.1.3

2 release files

0.1.2

2 release files

0.1.1

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