Skip to main content

A lightweight command-line tool for scaffolding minimal AI projects.

Project description

aikit-cli

aikit-cli is a lightweight command-line tool for scaffolding minimal AI projects.
It provides opinionated, ready-to-use boilerplate for common AI patterns.


Installation

pip install aikit-cli

Usage

Create a new project:

# Interactive mode
aikit-cli new my-bot

# One-liner
aikit-cli new my-bot --type chatbot --provider openai

Options

Option Shorthand Description Default
--type -t Project type (chatbot or rag) chatbot
--provider -p AI provider (openai or ollama) openai
--create-venv Create a virtual environment False
--non-interactive Fail if required options are missing instead of prompting False

Examples

Interactive Mode (Recommended):

aikit-cli new my-bot

Quick Create (Chatbot with OpenAI):

aikit-cli new my-bot --type chatbot --provider openai

Local RAG Project (with Ollama):

aikit-cli new local-rag --type rag --provider ollama

Generated Structure

After creating a project, you'll get a clean structure similar to this:

my-bot/
├── .env                # Environment variables (API keys, etc.)
├── app/
│   ├── __init__.py
│   ├── main.py         # Entry point
│   ├── config.py       # Configuration settings
│   └── provider.py     # LLM provider wrapper
├── pyproject.toml      # Project dependencies
└── README.md

Running Your Project

  1. Navigate to the created directory:
    cd my-bot
    

TODO: Add poetry/uv support + dependencies

  1. Install dependencies:

    pip install .  # or use poetry/uv
    
  2. Configure environment:

    • For OpenAI: Add OPENAI_API_KEY=sk-... to .env.
    • For Ollama: Ensure Ollama is running (ollama serve).
  3. Run the app:

    python app/main.py
    

Contributing

Contributions are welcome! Please open an issue or submit a pull request.

License

MIT

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

aikit_cli-0.1.0.tar.gz (11.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

aikit_cli-0.1.0-py3-none-any.whl (17.2 kB view details)

Uploaded Python 3

File details

Details for the file aikit_cli-0.1.0.tar.gz.

File metadata

  • Download URL: aikit_cli-0.1.0.tar.gz
  • Upload date:
  • Size: 11.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.2

File hashes

Hashes for aikit_cli-0.1.0.tar.gz
Algorithm Hash digest
SHA256 45d5fdccfb7ddb400bfe38824b3b09d2750f1a3d3544210af5e24aabfc8109a6
MD5 259c47ed1c1f52cfecbc78026b45f13c
BLAKE2b-256 95308b2d40fa339246daa3c0903872b71529a53f39d27f509a73efc3c9bd52d7

See more details on using hashes here.

File details

Details for the file aikit_cli-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: aikit_cli-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 17.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.2

File hashes

Hashes for aikit_cli-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 a6c4a27ae63ca386067585de5eccc94c7b52a6e9acf0f8ae463a65fe51be9a61
MD5 fe2d1774fa62ec334b50e49fecc9364b
BLAKE2b-256 705ef9a991c76ed9eb13ad37c18dbb738bdce7391ca934a66e6acde56e774037

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page