Skip to main content

AI powered terminal for Python developers.

Project description

BrixTerm by LLMBrix

About

AI powered terminal app for Python developers.

Has to be configured via ENV variables (see below).

Works with OpenAI models only.

Features

  • no command - either execute a terminal command. If command fails AI will suggest fix
  • you can directly spell out commands in natural language
  • type a my question for answer mode - chatbot in your terminal
  • type c my question for code mode - terminal generates piece of Python code and copies it to clipboard
  • chat history supported for all 3 modes (terminal, answer and code)
  • support for interactive sessions (e.g. htop)
  • history of commands (up to 1000 commands stored, retrieve with arrow up/down)
  • completions with TAB

Install

pip install brix-term

Configure

Set following ENV variables:

# (OPTIONAL) Model to be used, default is gpt-4o-mini, can use 'gpt-4o'
export BRIX_TERM_MODEL='gpt-4o-mini'

# (OPTIONAL) How many conversation turns to store in chat history, defaults are 3, 5, 3, as shown
export TERM_MODE_HIST=3
export ANSWER_MODE_HIST=5
export CODE_MODE_HIST=3

# Configure LLM API for OpenAI
export OPENAI_API_KEY='<TOKEN>'

# (OR) Configure LLM API for Azure OpenAI
export AZURE_OPENAI_API_KEY='<TOKEN>'
export AZURE_OPENAI_API_VERSION='<VERSION>'
export AZURE_OPENAI_ENDPOINT='<ENDPOINT>'

Run

Type in your terminal:

brixterm

Use

  • type valid unix command and it will run
  • type command with typo jit commit -am 'wip', it will fail. AI will automatically suggest fixed command version, confirm with y
  • type natural language sentence not starting with unix keyword e.g. list all files in this dir ending with .py", confirm with y
  • a what is diameter of earth? - will trigger answer mode, chatbot will answer in terminal directly
  • c deduplicate pandas dataframe - code will be generated into terminal and copied to clipboard
  • e or q to exit

License

This project is licensed under the MIT License.

Third-Party Licenses

This project includes open-source components licensed under their own terms. See THIRD_PARTY_LICENSES.txt for details.

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

brix_term-0.1.0a1.tar.gz (17.6 kB view details)

Uploaded Source

Built Distribution

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

brix_term-0.1.0a1-py3-none-any.whl (6.5 kB view details)

Uploaded Python 3

File details

Details for the file brix_term-0.1.0a1.tar.gz.

File metadata

  • Download URL: brix_term-0.1.0a1.tar.gz
  • Upload date:
  • Size: 17.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.9

File hashes

Hashes for brix_term-0.1.0a1.tar.gz
Algorithm Hash digest
SHA256 e294d0c9345515dabf9e2565349b8823c4a4ade6265f176f181b28c8e82e4120
MD5 b62d3e52d2a29446060a1e4a6c28a2b0
BLAKE2b-256 c73531125118499c4aecf924742336cea65d48cf42d7ad0f0457d610cfc7f854

See more details on using hashes here.

File details

Details for the file brix_term-0.1.0a1-py3-none-any.whl.

File metadata

  • Download URL: brix_term-0.1.0a1-py3-none-any.whl
  • Upload date:
  • Size: 6.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.9

File hashes

Hashes for brix_term-0.1.0a1-py3-none-any.whl
Algorithm Hash digest
SHA256 6a9522a8ec39efd210da742ab3cb31dde922658ebf7378abddb70cf5b57855ec
MD5 b3272d930f2d9979c1c64cc1a4a98af0
BLAKE2b-256 139567cbb8d115a4dbf6c81576f89e2420c83a6baf4e8c24dbf1c046c6c6eaf8

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