Skip to main content

Your customizable assistant in your CLI

Project description

open-copilot-cli

Continuous Integration Continuous Deployment Black Ruff

Open Copilot, your AI assistant in your terminal.

Getting Started

To begin, install the package:

pip install open-copilot-cli

Export your HF_TOKEN as an environment variable, you can get your token from HuggingFace:

Bash:

export HF_TOKEN=hf_**********************************

Powershell:

$env:HF_TOKEN = "hf_**********************************"

You are now ready to utilize the application.

Usage

To view the help options, run:

open-copilot --help

Ask questions

You can ask questions using natural language:

open-copilot ai 'list all files in the current directory'

Chat

Engage in a chat with OpenCopilot:

open-copilot chat --

# Export chat history
open-copilot chat -e chat-history.json

# Import chat history
open-copilot chat -h chat-history.json

# Import chat history and then export it after the session
open-copilot chat -h chat-history.json -e chat-history.json

Custom Large Language Models (LLMs)

Utilize custom LLMs:

open-copilot chat -m 'mistralai/Mistral-Nemo-Instruct-2407'

License

This project is licensed under the MIT License.

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

open_copilot_cli-0.1.2.tar.gz (4.2 kB view hashes)

Uploaded Source

Built Distribution

open_copilot_cli-0.1.2-py3-none-any.whl (6.6 kB view hashes)

Uploaded Python 3

Supported by

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