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 -
restorecommand reverts any AI changes immediately - Real shell - Run
git,pytest, evenvimwithout 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 snapshotsdiff: 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
- Install:
pip install axiomai-cli - Start chatting:
axiomai chatin 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:
- Built-in Commands (like
restoreormodel) - Shell Commands (like
ls -laorgit status) - AI Prompt (everything else)
Session & Model Control
new- Start a fresh chat sessionmodel- Select a different AI modelverbose [on|off]- Toggle verbose output on or offexit,quit,Ctrl+D- Exit the chathelp- Show available commands
Reviewing & Undoing AI Changes
restore,undo- Instantly undo the last set of changes made by AIhistory- Show the history of changes made by AIdiff <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
.gitignoreand.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.mdorAGENTS.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.
- Report bugs: GitHub Issues
- Submit PRs: Fork and contribute
- Get help: Discord Community
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
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file axiomai_cli-0.1.7.tar.gz.
File metadata
- Download URL: axiomai_cli-0.1.7.tar.gz
- Upload date:
- Size: 375.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.12.1
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
8d76316e97b9a0c9c892c27ac2a76a9402225e08c7a6e806ca3abc1fb77e70c9
|
|
| MD5 |
4c7b40bee8c51636beb65cd322dab3cc
|
|
| BLAKE2b-256 |
faaa53562795dad1a3ba2fc856926315b7394c1db319050acfe6af01e901e0ec
|
File details
Details for the file axiomai_cli-0.1.7-py3-none-any.whl.
File metadata
- Download URL: axiomai_cli-0.1.7-py3-none-any.whl
- Upload date:
- Size: 198.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.12.1
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
fbed077800df37e39023b7635fea0e7cdedbe1ea5876548ecdf4dc8fc92cde73
|
|
| MD5 |
70d777eff3512f84aced735502dbd10c
|
|
| BLAKE2b-256 |
2f0365c0d8dfecd6f6a8be36c0fcd28c4197902f27cd88161fd989fc3ac900b5
|