sgpt

(β˜… 456)

SGPT is a command-line tool that provides a convenient way to interact with OpenAI models, enabling users to run queries, generate shell commands and produce code directly from the terminal.

  • .bashrc
  • .dockerignore
  • .editorconfig
  • .envrc
  • .gitignore
  • .gitleaksignore
  • .golangci.yaml
  • .goreleaser.yaml
  • .mdl_config.yaml
  • .pre-commit-config.yaml
  • .readthedocs.yaml
  • .release-please-manifest.json
  • CHANGELOG.md
  • CODE_OF_CONDUCT.md
  • CODEOWNERS
  • CONTRIBUTING.md
  • Dockerfile
  • Dockerfile.goreleaser
  • flake.lock
  • flake.nix
  • go.mod
  • go.sum
  • LICENSE
  • mkdocs.yml
  • playbook.yml
  • README.md
  • release-please-config.json
  • renovate.json
  • SECURITY.md
  • Taskfile.yml

# Installation Guide

1. Get the code
git clone https://github.com/tbckr/sgpt

Downloads the entire project code from GitHub to your computer.

cd sgpt

Moves into the project folder you just downloaded.

2. Official Install Script

Easy Recommended
Prerequisites
  • Homebrew A package manager for macOS/Linux.
  • Scoop A package manager for Windows.
  • Go Go is required to use go install.
brew install tbckr/tap/sgpt

Installs the pre-built package via Homebrew β€” no source build required.

scoop install tbckr/sgpt

Installs directly via Scoop (Windows).

go install github.com/tbckr/sgpt/v2/cmd/sgpt@latest

Downloads and installs the specified version directly β€” no need to clone the repo yourself.

βœ… After installing, open a new terminal and run the program's version command (e.g. --version) to confirm it worked.

Pulled directly from this repo's README.

3. Docker

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
docker pull ghcr.io/tbckr/sgpt:latest

Type this command into your terminal and run it.

βœ… Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

Pulled directly from this repo's README.

4. Go

Medium
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Go The Go compiler and toolchain.
go install github.com/tbckr/sgpt/v2/cmd/sgpt@latest

Downloads and installs the specified version directly β€” no need to clone the repo yourself.

βœ… If the build finishes without errors, it worked. If you used go run ., check the terminal output.

Pulled directly from this repo's README.

// repository documentation