DocsGPT-CLI

DocsGPT-cli is a command-line interface (CLI) tool that allows you to interact with DocsGPT. It enables you to ask questions, configure settings, and manage DocsGPT API keys directly from your terminal.

---

Installation

You can install DocsGPT-cli in three ways:

1. Download the Binary

Download the latest binary. You can run it as is or use the install command to add the binary to your system's PATH:

./docsgpt-cli
./docsgpt-cli install

2. Compile from Source

If you want to make adjustments or compile the binary yourself, clone the repository and compile it:

git clone https://github.com/arc53/docsgpt-cli.git
cd docsgpt-cli
make build

After compiling, follow the same steps as for the binary:

3. Install via Homebrew

If you prefer using Homebrew, you can install DocsGPT-cli with the following commands:

brew tap arc53/docsgpt-cli
brew install docsgpt-cli

---

Usage

Once installed, you can start using docsgpt-cli by running the following commands:

docsgpt-cli [flags]
docsgpt-cli [command]

Available Commands:

• ask — Ask a question to DocsGPT
• help — Help about any command
• install — Install docsgpt-cli to your system's PATH
• keys — Manage DocsGPT API keys (add, set default, delete)
• settings — Configure the settings for docsgpt-cli

Flags:

• -h, --help — Help for docsgpt-cli
• -v, --version — Version for docsgpt-cli

You can use docsgpt-cli [command] --help to get more information about each command.

Here’s the updated section with the paragraph about the prompt:

---

Customizing the Prompt

We recommend changing the default DocsGPT prompt to make your interactions more efficient. By using a more concise prompt, you can get faster and more focused responses. For example, you can set the prompt to:

You are a embedded cli assistant docsgpt. You help users from terminal. Keep your answers very short. Just answer with a command if applicable.

---

Code Of Conduct

We as members, contributors, and leaders, pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation. Please refer to the CODE_OF_CONDUCT.md file for more information about contributing.