Metadata-Version: 2.4
Name: ce-tool
Version: 0.2.0
Summary: Token optimization wrapper for Claude Code sessions
Project-URL: Homepage, https://github.com/ShadowKingYT444/claude-efficient
Project-URL: Issues, https://github.com/ShadowKingYT444/claude-efficient/issues
License-Expression: MIT
License-File: LICENSE
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Python: >=3.11
Requires-Dist: click>=8.1
Requires-Dist: requests>=2.31
Requires-Dist: rich>=13.0
Provides-Extra: dev
Requires-Dist: build; extra == 'dev'
Requires-Dist: pytest-mock>=3.0; extra == 'dev'
Requires-Dist: pytest>=8.0; extra == 'dev'
Requires-Dist: ruff>=0.4; extra == 'dev'
Description-Content-Type: text/markdown

<div align="center">
  <br />
  <h1>Claude Efficient</h1>
  <p>
    <strong>Stop burning Claude Code tokens.</strong>
  </p>
  <p>
    <code>ce</code> wraps every session with automatic optimizations to save you money and improve context quality.
  </p>
</div>

---

## 🚀 Installation

`ce-tool` is a Python package. Ensure you have Python 3.11+ installed. Once installed, the `ce` command will be available globally in your terminal.

### Option 1: Install via pip (Recommended for all platforms)

**Windows, macOS, and Linux:**
```bash
pip install ce-tool
```

### Option 2: Install from Source (Git Clone)

If you prefer to clone the repository and run it locally, follow these steps.

**Windows, macOS, and Linux:**
```bash
# 1. Clone the repository
git clone https://github.com/thedotmack/claude-efficient.git

# 2. Navigate into the directory
cd claude-efficient

# 3. Install the package globally so the 'ce' command works anywhere
pip install -e .
```

## ✨ Quick Start

1.  **Initialize your project:**
    ```bash
    ce init
    ```
    This command sets up your project with a `CLAUDE.md`, `.claudeignore`, and other necessary configurations for optimal performance.

2.  **Run a task:**
    ```bash
    ce run "Your task description here. For example, build a FastAPI endpoint for user auth."
    ```
    This is the main command you'll use. It automatically optimizes your request, manages session context, and routes it appropriately.

3.  **Check your savings:**
    ```bash
    ce gains
    ```
    This command displays a detailed dashboard of your token savings across different operations. Token savings are tracked automatically and stored globally (`~/.ce-telemetry.jsonl`), allowing you to view your total savings across all projects.

## 🤖 Other AI CLIs

While `ce` acts as an optimizing wrapper around Claude Code, `ce-tool` also provides drop-in token optimization wrappers for other popular AI command-line tools. These wrappers apply the same prompt optimizations and track your token savings in the global `ce gains` dashboard.

- `ce-gemini`: Wraps the Google Gemini CLI (`gemini`).
- `ce-codex`: Wraps the OpenAI Codex CLI (`codex`).
- `ce-cursor`: Wraps the Cursor CLI (`cursor`).
- `ce-opencode`: Wraps the OpenCode CLI (`opencode`).

You can use these just like their underlying commands (e.g. `ce-gemini run "my task"`).

## 📋 Commands

`claude-efficient` provides a suite of commands to manage your workflow and optimize token usage.

| Command         | Description                                                              |
| --------------- | ------------------------------------------------------------------------ |
| `ce init`       | Initializes a new or existing project for use with `claude-efficient`.   |
| `ce run [TASK]` | Runs a new coding session with the given task, applying optimizations.   |
| `ce gains`      | Displays the token savings dashboard.                                    |
| `ce status`     | Shows a health dashboard for the current project configuration.          |
| `ce audit [LOG]`| Audits a session log to detect inefficiencies and suggest improvements.  |
| `ce mem-search` | Searches cross-session memory for relevant context from past tasks.      |
| `ce scope-check`| Estimates the token requirements for a task before running a session.    |
| `ce helpers`    | Provides assistance with setting up helpers and integrations.            |

---
<div align="center">
  <p>Made with ❤️ for efficient coding sessions.</p>
</div>
