tunacode-cli


Nametunacode-cli JSON
Version 0.0.75 PyPI version JSON
download
home_pageNone
SummaryYour agentic CLI developer.
upload_time2025-09-12 19:14:42
maintainerNone
docs_urlNone
authorNone
requires_python<3.14,>=3.10
licenseMIT
keywords agent automation cli development
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # TunaCode CLI

<div align="center">

[![PyPI version](https://badge.fury.io/py/tunacode-cli.svg)](https://badge.fury.io/py/tunacode-cli)
[![Downloads](https://pepy.tech/badge/tunacode-cli)](https://pepy.tech/project/tunacode-cli)
[![Python 3.10+](https://img.shields.io/badge/python-3.10+-blue.svg)](https://www.python.org/downloads/)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

**AI-powered CLI coding assistant**

![TunaCode Example](assets/tunacode_example.png)

</div>

---

## Quick Install

```bash
# Option 1: One-line install (Linux/macOS)
wget -qO- https://raw.githubusercontent.com/alchemiststudiosDOTai/tunacode/master/scripts/install_linux.sh | bash

# Option 2: pip install
pip install tunacode-cli
```

For detailed installation and configuration instructions, see the [**Getting Started Guide**](documentation/user/getting-started.md).

## Development Installation

For contributors and developers who want to work on TunaCode:

```bash
# Clone the repository
git clone https://github.com/alchemiststudiosDOTai/tunacode.git
cd tunacode

# Quick setup (recommended)
./scripts/setup_dev_env.sh

# Or manual setup
python3 -m venv venv
source venv/bin/activate  # On Windows: venv\Scripts\activate
pip install -e ".[dev]"

# Verify installation
python -m tunacode --version
```

See the [Hatch Build System Guide](documentation/development/hatch-build-system.md) for detailed instructions on the development environment.

## Configuration

Choose your AI provider and set your API key. For more details, see the [Configuration Section](documentation/user/getting-started.md#2-configuration) in the Getting Started Guide. For local models (LM Studio, Ollama, etc.), see the [Local Models Setup Guide](documentation/configuration/local-models.md).

### Recommended Models

Based on extensive testing, these models provide the best performance:

- `google/gemini-2.5-pro` - Excellent for complex reasoning
- `openai/gpt-4.1` - Strong general-purpose model
- `deepseek/deepseek-r1-0528` - Great for code generation
- `openai/gpt-4.1-mini` - Fast and cost-effective
- `anthropic/claude-4-sonnet-20250522` - Superior context handling

_Note: Formal evaluations coming soon. Any model can work, but these have shown the best results in practice._

## Start Coding

```bash
tunacode
```

## Basic Commands

| Command                  | Description            |
| ------------------------ | ---------------------- |
| `/help`                  | Show all commands      |
| `/model <provider:name>` | Switch model           |
| `/clear`                 | Clear message history  |
| `/compact`               | Summarize conversation |
| `/branch <name>`         | Create Git branch      |
| `/yolo`                  | Skip confirmations     |
| `!<command>`             | Run shell command      |
| `exit`                   | Exit TunaCode          |

## Performance

TunaCode leverages parallel execution for read-only operations, achieving **3x faster** file operations:

![Parallel Execution Performance](docs/assets/parrelel_work_3x.png)

Multiple file reads, directory listings, and searches execute concurrently using async I/O, making code exploration significantly faster.

## Features in Development

- **Bug Fixes**: Actively addressing issues - please report any bugs you encounter!

_Note: While the tool is fully functional, we're focusing on stability and core features before optimizing for speed._

## Safety First

⚠️ **Important**: TunaCode can modify your codebase. Always:

- Use Git branches before making changes
- Review file modifications before confirming
- Keep backups of important work

## Documentation

For a complete overview of the documentation, see the [**Documentation Hub**](documentation/README.md).

### User Documentation

- [**Getting Started**](documentation/user/getting-started.md) - How to install, configure, and use TunaCode.
- [**Commands**](documentation/user/commands.md) - A complete list of all available commands.

### Developer Documentation

- **Architecture** (planned) - The overall architecture of the TunaCode application.
- **Contributing** (planned) - Guidelines for contributing to the project.
- **Tools** (planned) - How to create and use custom tools.
- **Testing** (planned) - Information on the testing philosophy and how to run tests.

### Guides

- [**Advanced Configuration**](documentation/configuration/config-file-example.md) - An example of an advanced configuration file.

### Reference

- **Changelog** (planned) - A history of changes to the application.
- **Roadmap** (planned) - The future direction of the project.
- **Security** (planned) - Information about the security of the application.

## Links

- [PyPI Package](https://pypi.org/project/tunacode-cli/)
- [GitHub Repository](https://github.com/alchemiststudiosDOTai/tunacode)
- [Report Issues](https://github.com/alchemiststudiosDOTai/tunacode/issues)

---

MIT License - see [LICENSE](LICENSE) file

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "tunacode-cli",
    "maintainer": null,
    "docs_url": null,
    "requires_python": "<3.14,>=3.10",
    "maintainer_email": null,
    "keywords": "agent, automation, cli, development",
    "author": null,
    "author_email": "larock22 <noreply@github.com>",
    "download_url": "https://files.pythonhosted.org/packages/e7/3b/94711e79af833019eda6bba0af49ddec5a054fceaa4152547c1f77bfdeff/tunacode_cli-0.0.75.tar.gz",
    "platform": null,
    "description": "# TunaCode CLI\n\n<div align=\"center\">\n\n[![PyPI version](https://badge.fury.io/py/tunacode-cli.svg)](https://badge.fury.io/py/tunacode-cli)\n[![Downloads](https://pepy.tech/badge/tunacode-cli)](https://pepy.tech/project/tunacode-cli)\n[![Python 3.10+](https://img.shields.io/badge/python-3.10+-blue.svg)](https://www.python.org/downloads/)\n[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)\n\n**AI-powered CLI coding assistant**\n\n![TunaCode Example](assets/tunacode_example.png)\n\n</div>\n\n---\n\n## Quick Install\n\n```bash\n# Option 1: One-line install (Linux/macOS)\nwget -qO- https://raw.githubusercontent.com/alchemiststudiosDOTai/tunacode/master/scripts/install_linux.sh | bash\n\n# Option 2: pip install\npip install tunacode-cli\n```\n\nFor detailed installation and configuration instructions, see the [**Getting Started Guide**](documentation/user/getting-started.md).\n\n## Development Installation\n\nFor contributors and developers who want to work on TunaCode:\n\n```bash\n# Clone the repository\ngit clone https://github.com/alchemiststudiosDOTai/tunacode.git\ncd tunacode\n\n# Quick setup (recommended)\n./scripts/setup_dev_env.sh\n\n# Or manual setup\npython3 -m venv venv\nsource venv/bin/activate  # On Windows: venv\\Scripts\\activate\npip install -e \".[dev]\"\n\n# Verify installation\npython -m tunacode --version\n```\n\nSee the [Hatch Build System Guide](documentation/development/hatch-build-system.md) for detailed instructions on the development environment.\n\n## Configuration\n\nChoose your AI provider and set your API key. For more details, see the [Configuration Section](documentation/user/getting-started.md#2-configuration) in the Getting Started Guide. For local models (LM Studio, Ollama, etc.), see the [Local Models Setup Guide](documentation/configuration/local-models.md).\n\n### Recommended Models\n\nBased on extensive testing, these models provide the best performance:\n\n- `google/gemini-2.5-pro` - Excellent for complex reasoning\n- `openai/gpt-4.1` - Strong general-purpose model\n- `deepseek/deepseek-r1-0528` - Great for code generation\n- `openai/gpt-4.1-mini` - Fast and cost-effective\n- `anthropic/claude-4-sonnet-20250522` - Superior context handling\n\n_Note: Formal evaluations coming soon. Any model can work, but these have shown the best results in practice._\n\n## Start Coding\n\n```bash\ntunacode\n```\n\n## Basic Commands\n\n| Command                  | Description            |\n| ------------------------ | ---------------------- |\n| `/help`                  | Show all commands      |\n| `/model <provider:name>` | Switch model           |\n| `/clear`                 | Clear message history  |\n| `/compact`               | Summarize conversation |\n| `/branch <name>`         | Create Git branch      |\n| `/yolo`                  | Skip confirmations     |\n| `!<command>`             | Run shell command      |\n| `exit`                   | Exit TunaCode          |\n\n## Performance\n\nTunaCode leverages parallel execution for read-only operations, achieving **3x faster** file operations:\n\n![Parallel Execution Performance](docs/assets/parrelel_work_3x.png)\n\nMultiple file reads, directory listings, and searches execute concurrently using async I/O, making code exploration significantly faster.\n\n## Features in Development\n\n- **Bug Fixes**: Actively addressing issues - please report any bugs you encounter!\n\n_Note: While the tool is fully functional, we're focusing on stability and core features before optimizing for speed._\n\n## Safety First\n\n\u26a0\ufe0f **Important**: TunaCode can modify your codebase. Always:\n\n- Use Git branches before making changes\n- Review file modifications before confirming\n- Keep backups of important work\n\n## Documentation\n\nFor a complete overview of the documentation, see the [**Documentation Hub**](documentation/README.md).\n\n### User Documentation\n\n- [**Getting Started**](documentation/user/getting-started.md) - How to install, configure, and use TunaCode.\n- [**Commands**](documentation/user/commands.md) - A complete list of all available commands.\n\n### Developer Documentation\n\n- **Architecture** (planned) - The overall architecture of the TunaCode application.\n- **Contributing** (planned) - Guidelines for contributing to the project.\n- **Tools** (planned) - How to create and use custom tools.\n- **Testing** (planned) - Information on the testing philosophy and how to run tests.\n\n### Guides\n\n- [**Advanced Configuration**](documentation/configuration/config-file-example.md) - An example of an advanced configuration file.\n\n### Reference\n\n- **Changelog** (planned) - A history of changes to the application.\n- **Roadmap** (planned) - The future direction of the project.\n- **Security** (planned) - Information about the security of the application.\n\n## Links\n\n- [PyPI Package](https://pypi.org/project/tunacode-cli/)\n- [GitHub Repository](https://github.com/alchemiststudiosDOTai/tunacode)\n- [Report Issues](https://github.com/alchemiststudiosDOTai/tunacode/issues)\n\n---\n\nMIT License - see [LICENSE](LICENSE) file\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "Your agentic CLI developer.",
    "version": "0.0.75",
    "project_urls": {
        "Documentation": "https://github.com/alchemiststudiosDOTai/tunacode#readme",
        "Homepage": "https://tunacode.xyz/",
        "Issues": "https://github.com/alchemiststudiosDOTai/tunacode/issues",
        "Repository": "https://github.com/alchemiststudiosDOTai/tunacode"
    },
    "split_keywords": [
        "agent",
        " automation",
        " cli",
        " development"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "e2b594abd5a35e38b5aba3eec6066ad02432dee84b25ed163c670dc5176600ee",
                "md5": "5c17f78f13706deea2b3cfde7c8f7b67",
                "sha256": "285e2fdcfaeaf73faf1ac2f33a19f5e9eb8496e63c984c84f043567f6669cb66"
            },
            "downloads": -1,
            "filename": "tunacode_cli-0.0.75-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "5c17f78f13706deea2b3cfde7c8f7b67",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "<3.14,>=3.10",
            "size": 265642,
            "upload_time": "2025-09-12T19:14:40",
            "upload_time_iso_8601": "2025-09-12T19:14:40.492313Z",
            "url": "https://files.pythonhosted.org/packages/e2/b5/94abd5a35e38b5aba3eec6066ad02432dee84b25ed163c670dc5176600ee/tunacode_cli-0.0.75-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "e73b94711e79af833019eda6bba0af49ddec5a054fceaa4152547c1f77bfdeff",
                "md5": "cd5b0cbff9e6fad270b44423ae7a7fdd",
                "sha256": "89c235eaebf0cad4db853cd02b089efc5441ab34b62e1e5a118ba61e7db924c7"
            },
            "downloads": -1,
            "filename": "tunacode_cli-0.0.75.tar.gz",
            "has_sig": false,
            "md5_digest": "cd5b0cbff9e6fad270b44423ae7a7fdd",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "<3.14,>=3.10",
            "size": 1361590,
            "upload_time": "2025-09-12T19:14:42",
            "upload_time_iso_8601": "2025-09-12T19:14:42.324896Z",
            "url": "https://files.pythonhosted.org/packages/e7/3b/94711e79af833019eda6bba0af49ddec5a054fceaa4152547c1f77bfdeff/tunacode_cli-0.0.75.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-09-12 19:14:42",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "alchemiststudiosDOTai",
    "github_project": "tunacode#readme",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "tunacode-cli"
}
        
Elapsed time: 1.01855s