Skip to main content

Command-line real-time conversation app

Project description

y-cli 🚀

A tiny command-line interface chat application that brings AI conversations to your terminal.

Check out y-gui for a web-based version of y-cli.

✨ Features

  • 📝 Flexible storage options:
    • Local JSONL files for easy access and sync
    • Cloudflare D1 for cloud storage
  • 💬 Interactive chat interface with tool execution visualization
  • 🤖 Support for multiple bot configurations (any base_url/api_key/model combination). Supported api format type:
  • 🤔 Support for reasoning model
  • 🔗 MCP (Model Context Protocol) integration:
    • Client support with multiple server configurations (stdio/SSE)
    • Persistent daemon
    • Custom prompt configurations
  • 🧐 Simple "Deep Research" mode by prompt configuration

Demo

demo

demo

asciicast

Multiple bot configurations

➜  ~ y-cli bot list
Name         API Key      API Type    Base URL                             Model                                Print Speed    Description    OpenRouter Config    MCP Servers    Reasoning Effort
-----------  -----------  ----------  -----------------------------------  -----------------------------------  -------------  -------------  -------------------  -------------  ------------------
default      sk-or-v1...  N/A         https://gateway.ai.cloudflare.co...  google/gemini-2.0-flash-001          None            N/A            Yes                  No             N/A
claude       sk-or-v1...  N/A         https://gateway.ai.cloudflare.co...  anthropic/claude-3.7-sonnet:beta     None             N/A            Yes                  todo           N/A
o3-mini      sk-or-v1...  N/A         https://gateway.ai.cloudflare.co...  openai/o3-mini                       None             N/A            Yes                  No             low
ds-chat        sk-or-v1...  N/A         https://gateway.ai.cloudflare.co...  deepseek/deepseek-chat-v3-0324:free                 None            N/A            Yes                  tavily         N/A
dify-bot     app-2drF...  dify        https://api.dify.ai/v1                                                    None             N/A            No                   No             N/A

Multiple MCP servers

➜  ~ y-cli mcp list
Name            Type    Command/URL          Arguments/Token    Environment     Auto-Confirm
--------------  ------  -------------------  -----------------  --------------  --------------
brave-search    sse     https://router.m...                                     brave_web_s...
todo            stdio   uvx                  mcp-todo
exa-mcp-server  stdio   npx                  exa-mcp-server     EXA_API_KEY...

⚡ Quick Start

Prerequisites

Required:

  1. uv
  2. OpenRouter API key

Setup Instructions:

  1. uv

  2. OpenRouter API key

Run without Installation

uvx y-cli

Install with uv tool

uv tool install y-cli

Initialize

y-cli init

Start Chat

y-cli chat

🛠️ Usage

y-cli [OPTIONS] COMMAND [ARGS]...

Commands

  • chat Start a new chat conversation or continue an existing one
  • list List chat conversations with optional filtering
  • share Share a chat conversation by generating a shareable link
  • import Import chats from an external file (useful for storage migration)
  • bot Manage bot configurations:
    • add Add a new bot configuration
    • list List all configured bots
    • delete Delete a bot configuration
  • mcp Manage MCP server configurations:
    • add Add a new MCP server configuration
    • list List all configured MCP servers
    • delete Delete an MCP server configuration
  • daemon Manage the MCP daemon:
    • start Start the MCP daemon
    • stop Stop the MCP daemon
    • status Check daemon status
    • log View daemon logs
    • restart Restart the daemon
  • prompt Manage prompt configurations:
    • add Add a new prompt configuration
    • list List all configured prompts
    • delete Delete a prompt configuration

Options

  • --help Show help message and exit

📚 Documentation

Visit the deepwiki page for comprehensive project documentation and guides.

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

y_cli-0.4.0.tar.gz (62.0 kB view details)

Uploaded Source

Built Distribution

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

y_cli-0.4.0-py3-none-any.whl (87.5 kB view details)

Uploaded Python 3

File details

Details for the file y_cli-0.4.0.tar.gz.

File metadata

  • Download URL: y_cli-0.4.0.tar.gz
  • Upload date:
  • Size: 62.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.10.17

File hashes

Hashes for y_cli-0.4.0.tar.gz
Algorithm Hash digest
SHA256 0254e7db560016491ea01c2fff182096f927e81322378bc68bbaa0a71bb138cb
MD5 53e419e757c8c76e5a30e6dd6b313ade
BLAKE2b-256 7394e0e46ef6597569497479bc0da4a620474b193411f2c453150676898a493d

See more details on using hashes here.

File details

Details for the file y_cli-0.4.0-py3-none-any.whl.

File metadata

  • Download URL: y_cli-0.4.0-py3-none-any.whl
  • Upload date:
  • Size: 87.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.10.17

File hashes

Hashes for y_cli-0.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 6ffad6f81b46790ff766e51c66937be9d6131dfbddb6049036a299e5f3f5cfcf
MD5 690f8bd092a17c5870dbae560a21374b
BLAKE2b-256 74dad14e86f5886684510e4478a8e14f4ac18c9c3c87af013cf1f5cddba4be50

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