@johannlai/gptcli v4.6.0

GPT CLI is a command-line interface tool that allows you to create your own ChatGPT CLI tools in seconds. It's as simple as creating a GitHub Actions workflow. With GPT CLI, you can customize your CLI tools to suit your needs and make your work more efficient.

Note: ALL the commit message is wrote by this plugin, awesome!

🚀 Features

• All in one ChatGPT CLI
• Create custom ChatGPT CLI tools in seconds
• Customize your CLI tools to suit your needs
• Easy to install and use

🔧 Installation

You can install GPT CLI using npm or brew:

npm

To run this CLI tool, you need to have Node.js version 16+ , recommended to use nvm to manage node version.

npm install -g @johannlai/gptcli

brew(WIP)

brew install johannlai/tap/gptcli

Setup alias convenience commands

These will add the commands to your shell, but only for the current session. To make them available in all future sessions, you should add the above command on a line by itself to the bottom of your .zshrc or .bashrc or equivalent.

eval "$(gptcli alias)"

NOW, you can use ?? to start AI Command

$ ?? "show all js files in the current folder"
> AI is thinking...
# then you will see the result
> ls -al | grep .js

# chat?
$ chat?
👽: Hi, I am ChatGpt, I can answer your questions. Ask me anything, or say "bye" to exit.
? 🫣 how git diff --cached add EXCLUDE

# translate ： t? "hello world"
$ t? "hello world"
> 你好，世界

# for more plugins, please check the plugins section

🧰 Built-in Plugins

GPT CLI comes with a variety of built-in plugins to help you get started. Here's a table of the current built-in plugins:

Help of built-in plugins

You can get help for each plugin by running the following command:

# chat plugin
gptcli chat help

# command plugin
gptcli command help

# and so on

List of built-in plugins

gptcli list

🛠️ Configuration

User configuration

🎉 Now! feel free to use MY OWN ChatGPT API KEY, but it's not recommended, because it's not stable, you can use your own API KEY, just follow the steps below:

gptcli config user.OPENAI_API_KEY sk-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

You can get your own API KEY from OpenAI

To configure the plugin

Some plugins require additional configuration to work properly. For example, the commit plugin requires a commit style to be specified. To configure the plugin, you can use the gptcli config command. For example, to configure the commit plugin to use the cz commit style, you can run the following command:

# cz style: fix: fix a bug
gptcli config commit.style cz

or gitmoji style:

# gitmoji style: 🐛 fix a bug
gptcli config commit.style gitmoji

👥 Community plugins

Coming soon...

Will be displayed in the website :)

For now, you can share your plugin with the community by submitting a pull request to add it to the list of community plugins. thanks! 👍

🎨 Customization, Build your own plugin in seconds

To create your own CLI plugin, you can fork this template repository and customize it to suit your needs. You can test your plugin locally and then install it globally using gptcli. For more information on how to create your own plugin, please refer to the template repository.

Don't forget to share your plugin with the community by submitting a pull request to add it to the list of community plugins.

It's easy to build your own plugin, just one YAML file

name: joke
description: "joke plugin for gpt cli"
repository: "johannlai/joke"
author: "johannlai"
help: |
  joke plugin for gpt cli
  Usage:
    ❯ gpt joke
    ❯ "Why did the tomato turn red? Because it saw the salad dressing!"
steps:
  - name: "ask ai to output joke"
    # use the gpt:createChatCompletion action to create a chat completion
    uses: "gpt:createChatCompletion"
    with:
      messages:
        - role: "user"
          content: "tell me a joke"
    export:
      # export the response content to the JOKE environment variable
      response_content: JOKE
  - name: "output response"
    # output the JOKE environment variable
    script: |
      echo $JOKE

For more information, please refer to the template repository

📜 License

GPT CLI is licensed under the MIT License. See the LICENSE file for more information.

📋 Other Information

For more information on how to use GPT CLI, please refer to the official website.

Issues

Ask questions, report bugs, and request features on the GitHub issues page

💻 Build by GitHub & ChatGPT with ❤️