axiomai-cli 0.1.0

Axiom: Your Coding Assistant

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

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 .
axiom

What it does

$ Axiom
> 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 ayechat
2. Start chatting: Axiom in any project folder

Get started - Windows Installer

For Windows users, the recommended way to install Axiom is with the official installer. It provides a standalone application that requires no manual setup.

Installation

1. Download the latest aye-chat-setup.exe from the GitHub Releases page.
2. Run the downloaded installer.
3. During setup, it is highly recommended to keep the following options enabled:
   • Add the application directory to your PATH
   • Add 'Open Axiom here' to folder context menu

Usage

After installation, you can launch Axiom by:

• Typing aye in any terminal.
• Right-clicking a project folder and selecting Open Axiom here.

---

📚 Full command reference

Core Commands

Authentication

Does not require authentication

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.

• 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

Wiki • Discord • GitHub