picobot 0.3.1

A tiny bot built for simplicity

Pico Bot

A lightweight terminal-based AI assistant for simple, interactive chat.

Features

• Terminal-based chat interface for quick, interactive use
• OpenAI integration powered by LangChain
• Conversation memory to preserve context during a session
• Safe local file access limited to the project root
• Recursive directory listing support
• config.toml support for customizing directory listing defaults
• Git-like ignore patterns to reduce noise, token usage, and accidental exposure of unneeded files
• Accurate cost tracking with cached input token support, down to 6 decimal places

Screenshot

Installation

Requirements

• Python 3.12 (tested)
• An OpenAI API key

For Users

Install Pico Bot from PyPI:

pip install picobot

For Development

Clone the repository and install in editable mode:

git clone [e-mail]:ngpeijiun/picobot.git
cd picobot
python -m venv .venv
source .venv/bin/activate   # Windows: .venv\Scripts\activate
pip install -e .

Configuration

Set your OpenAI API key in your environment:

export OPENAI_API_KEY="your_api_key"

On Windows PowerShell:

$env:OPENAI_API_KEY="your_api_key"

config.toml

You can place a config.toml file in your Pico Bot user config directory. Pico Bot reads it from:

On Linux and macOS:

~/.config/picobot/config.toml

On Windows:

C:\Users\<YourName>\.config\picobot\config.toml

Pico Bot uses this file to configure list_dir defaults.

Example:

[list_dir]
ignore = [".git/", ".venv/", "__pycache__/", "dist/"]
max_depth = 4
max_entries = 500

Notes:

• ".venv" ignores both a file named .venv and a directory named .venv/
• ".venv/" ignores only the directory .venv/

Backward Compatibility

See Backward Compatibility for legacy config support. This backward compatibility will be dropped in the official 1.0 release.

Usage

picobot

Type exit or quit to leave the session.

Safety

The read_file and list_dir tools only allow access to files inside the project root directory. This helps prevent path traversal outside the repository.

The list_dir tool supports simple gitignore-like ignore patterns to reduce noise, token usage, and accidental exposure of unneeded files. This is intended for convenience only; it is not a security boundary and should not be relied on to protect secrets.

Roadmap

• Add more tools
• Add tests
• Improve configuration and error handling

License

MIT