diff --git a/README.md b/README.md index ac6a944..dec37b0 100644 --- a/README.md +++ b/README.md @@ -7,37 +7,91 @@ Get answers from GPT3 right inside your terminal. [![Downloads/week](https://img.shields.io/npm/dw/@abhagsain/ai-cli.svg)](https://npmjs.org/package/@abhagsain/ai-cli) - -- [GPT3 Powered CLI](#gpt3-powered-cli) -- [Usage](#usage) -- [Commands](#commands) +* [GPT3 Powered CLI](#gpt3-powered-cli) +* [Usage](#usage) +* [Commands](#commands) # Usage - -```sh +```sh-session $ npm install -g @abhagsain/ai-cli -$ ai ask COMMAND +$ ai COMMAND running command... $ ai (--version) -@abhagsain/ai-cli/0.0.1-0 darwin-x64 node-v14.18.3 - +@abhagsain/ai-cli/0.0.1-1 darwin-x64 node-v14.18.3 $ ai --help [COMMAND] - USAGE $ ai COMMAND - $ ai ask "Check if the remote port is open" - nc -vz ... ``` - # Commands +* [`ai ask [question]`](#ai-ask-question) +* [`ai auth`](#ai-auth) +* [`ai help [COMMAND]`](#ai-help-command) + +## `ai ask [question]` + +Get answers from GPT3 right from your terminal + +``` +USAGE + $ ai ask [question] + +ARGUMENTS + QUESTION Your question + +DESCRIPTION + Get answers from GPT3 right from your terminal + +EXAMPLES + $ ai ask "Check running process on port 3000" +``` + +_See code: [dist/commands/ask.ts](https://github.com/abhagsain/ai-cli/blob/v0.0.1-1/dist/commands/ask.ts)_ + +## `ai auth` + +Add existing or new OpenAI API Key + +``` +USAGE + $ ai auth + +DESCRIPTION + Add existing or new OpenAI API Key + +EXAMPLES + $ ai auth (Follow the prompt) +``` + +_See code: [dist/commands/auth.ts](https://github.com/abhagsain/ai-cli/blob/v0.0.1-1/dist/commands/auth.ts)_ + +## `ai help [COMMAND]` + +Display help for ai. + +``` +USAGE + $ ai help [COMMAND] [-n] + +ARGUMENTS + COMMAND Command to show help for. + +FLAGS + -n, --nested-commands Include all nested commands in the output. + +DESCRIPTION + Display help for ai. +``` + +_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v5.1.17/src/commands/help.ts)_ + - [`ai ask [question]`](#ai-ask-question) - [`ai auth`](#ai-auth) diff --git a/package.json b/package.json index 8271a7d..b8c6580 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@abhagsain/ai-cli", - "version": "0.0.1-0", + "version": "0.0.1-1", "description": "Get answers from GPT3 right from your terminal", "author": "Anurag Bhagsain @abhagsain", "bin": { @@ -78,4 +78,4 @@ "oclif" ], "types": "dist/index.d.ts" -} \ No newline at end of file +}