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.3.tar.gz (4.5 kB view details)

Uploaded Source

Built Distribution

open_copilot_cli-0.1.3-py3-none-any.whl (6.8 kB view details)

Uploaded Python 3

File details

Details for the file open_copilot_cli-0.1.3.tar.gz.

File metadata

  • Download URL: open_copilot_cli-0.1.3.tar.gz
  • Upload date:
  • Size: 4.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.3 CPython/3.10.12 Linux/6.8.0-1014-azure

File hashes

Hashes for open_copilot_cli-0.1.3.tar.gz
Algorithm Hash digest
SHA256 18a1c54301d519b92231f8689a3e8a5937858ebbcd64cbfff82243fbf770ec27
MD5 755090162fdf10c4b6104b307abbcd98
BLAKE2b-256 d7ab036208246c99fe2b59380aa908c0d91eac5ce4dfea028c02444f308f3d9f

See more details on using hashes here.

File details

Details for the file open_copilot_cli-0.1.3-py3-none-any.whl.

File metadata

  • Download URL: open_copilot_cli-0.1.3-py3-none-any.whl
  • Upload date:
  • Size: 6.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.3 CPython/3.10.12 Linux/6.8.0-1014-azure

File hashes

Hashes for open_copilot_cli-0.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 0436330f4813e9c91221a45d7af2068eebb27cc16b8484ec7a6ff04984327465
MD5 33f811fa51694581e3a314c01204a593
BLAKE2b-256 c369e74202b73643be19d26bba0737e9292713cee07d4443073a5a782ba5b67f

See more details on using hashes here.

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