Categorygithub.com/SumDeusVitae/cli-assistant-client
repositorypackage
1.5.2
Repository: https://github.com/sumdeusvitae/cli-assistant-client.git
Documentation: pkg.go.dev
Overview
Dependencies
11
Dependents
0

# README

Go Reference Go Report Card CI Status

Table of Contents

Introduction

CLI Assistant is a command-line tool that lets you ask questions and get answers directly in the terminal. It's perfect for situations where you don’t have access to a web browser, but still need quick answers or help solving problems. Whether you need a quick reminder, a bit of troubleshooting, or just some general knowledge, CLI Assistant has you covered—all from the comfort of your command line.

Example

CLI ASSISTANT Example

Installation

1. Install Go 1.22 or later

The Boot.dev CLI requires a Golang installation, and only works on Linux and Mac. If you're on Windows, you'll need to use WSL. Make sure you install go in your Linux/WSL terminal, not your Windows terminal/UI. There are two options:

Option 1: The webi installer is the simplest way for most people. Just run this in your terminal:

curl -sS https://webi.sh/golang | sh

Read the output of the command and follow any instructions.

Option 2: Use the official installation instructions.

Run go version on your command line to make sure the installation worked. If it did, move on to step 2.

Optional troubleshooting:

  • If you already had Go installed with webi, you should be able to run the same webi command to update it.

  • If you already had a version of Go installed a different way, you can use which go to find out where it is installed, and remove the old version manually.

  • If you're getting a "command not found" error after installation, it's most likely because the directory containing the go program isn't in your PATH. You need to add the directory to your PATH by modifying your shell's configuration file. First, you need to know where the go command was installed. It might be in:

  • ~/.local/opt/go/bin (webi)

  • /usr/local/go/bin (official installation)

  • Somewhere else?

You can ensure it exists by attempting to run go using its full filepath. For example, if you think it's in ~/.local/opt/go/bin, you can run ~/.local/opt/go/bin/go version. If that works, then you just need to add ~/.local/opt/go/bin to your PATH and reload your shell:

# For Linux/WSL
echo 'export PATH=$PATH:$HOME/.local/opt/go/bin' >> ~/.bashrc
# next, reload your shell configuration
source ~/.bashrc

# For Mac OS
echo 'export PATH=$PATH:$HOME/.local/opt/go/bin' >> ~/.zshrc
# next, reload your shell configuration
source ~/.zshrc

2. Installing CLI ASSISTANT

This command will download, build, and install the cli-assistant-client command into your Go toolchain's bin directory. Go ahead and run it:

go install github.com/SumDeusVitae/cli-assistant-client@latest

After this, rename the binary:

mv $(go env GOPATH)/bin/cli-assistant-client $(go env GOPATH)/bin/qs

Now, you run your app using qs instead of cli-assistant-client. Run this command to check:

qs version

If it didn't work try:

cli-assistant-client version

If it works Perhaps rm didn't work due to permission issues. Try using cp to copy the file first, and then remove the original:

cp $(go env GOPATH)/bin/cli-assistant-client $(go env GOPATH)/bin/qs
rm $(go env GOPATH)/bin/cli-assistant-client

Usage

To run CLI ASSISTANT, use following commands.

For New Users:

Please register first. Note: Email is optional. It may be helpful for password recovery if you forget your password.

qs register

For Existing Users:

If you already have an account, simply log in:

qs login

Asking Questions:

After registering or logging in, you can ask a question using the following command:

qs q <your question here>

This will return the response to your query. This is the core functionality of the tool.

To see a list of available commands, use:

qs help

Alternatively, you can find the available commands in the "Commands" section below.

Commands

  • help: Displays a help message
  • register: Registers new user
  • login: Login as existent user
  • q <question>: Asks AI question
  • whoami: Checks if you logged in
  • helth: Checking server status
  • version: Checks current version
  • env: Shows saved environmental variables
  • update: Updates CLI to the latest version

Uninstall

To uninstall CLI Assistant, follow the steps :

Locate the binary: Find the binary in your GOBIN or GOPATH/bin directory. Remove the binary: Delete it from the terminal:

rm $(go env GOPATH)/bin/qs

Remove the source code (optional):

rm -rf $(go env GOPATH)/src/github.com/SumDeusVitae/cli-assistant-client

Contributing 🤝

Clone the repo

git clone https://github.com/sumdeusvitae/cli-assistant-client@latest
cd cli-assistant-client

Build the project

go build -o qs

Run the project

./qs register
./qs q <your question>

Run the tests

go test ./...

Submit a pull request

If you'd like to contribute, please fork the repository and open a pull request to the main branch.