Skip to main content

A terminal agent for terminal users.

Project description

Terminal-Agent-X

EN / 中文 / Wiki

Install

pip install terminal-agent-x

Config

You need to add the environment variable OpenAI_KEY to the path.

# On Linux
vim ~/.bashrc
# add this line to the end of the file
export OpenAI_KEY=sk-xxx
# save and execute
source ~/.bashrc

# For Windows, you can google how to set environment variables on Windows.

Use python -c "import os;print(os.environ.get('OpenAI_KEY'))" for testing.

You can get your OpenAI_KEY from OpenAI.

Get Started

You can use the tax <prompt> to interact with the model, like this:

tax write a python code for fibonacci

Use tax -h to get more information.

usage: tax [-h] [--key KEY] [--model MODEL] [--file FILE] [--url URL] [--show_all] prompt [prompt ...]

Tax: A terminal agent using OpenAI/Claude API

positional arguments:
  prompt         Prompt

options:
  -h, --help     show this help message and exit
  --key KEY      Your key for OpenAI//Claude, only for one-time request
  --model MODEL  Model name. You can use all OpenAI models.
  --file FILE    Output file. If specified, the output will be written to this file. Tax will act like ChatGPT
  --url URL      URL for API request. Choose from ['openai_gfw', 'openai', 'claude'] or your custom url. The default one can be accessd under GFW.
  --show_all     Show all contents in the response

Support

I have tested on Windows 10/11(cmd) and Ubuntu 22.04, it should work on other platforms.

Attention

You can see a directive after the generated command that says

Do you want to execute the command? (y/n)

Please execute it or not at your own discretion. I am not responsible for the consequences of generated commands.

License

GNU General Public License v3.0

Development Logs

0.1.0
  • Implement basic functions
  • Support for Windows cmd and Linux shell
  • Add --file option for saving the response to a file
0.1.1
  • Add --show_all option for showing all contents of the response.
  • Add --url option for users not under GFW.
  • Add support for Windows Powershell
0.1.2
  • [WIP]Add Anthropic Claude API Support. Thanks to jtsang4/claude-to-chatgpt.
  • Add Support for Chinese on Linux and Windows. (also add a temporary solution for VSCode Terminal on Windows).
  • Add a timeout function.
  • Fix: C++ code block prefix.
0.1.3
  • Fix: code block prefix bug (tax will act maybe a little faster).
  • Modify: simplify the code.
  • Test: test for multi-process. Now you can use tax more efficiently in terminal.

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

terminal-agent-x-0.1.3.tar.gz (17.3 kB view hashes)

Uploaded Source

Built Distribution

terminal_agent_x-0.1.3-py3-none-any.whl (17.8 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