AlmightyGPT markAlmightyGPT
Docs navigation
Quickstart

Install once, then give each repo the convention.

Follow this path when you are trying AlmightyGPT for the first time. It keeps setup short and shows the exact files and commands you should expect.

1. Install the CLI

Terminal
> npm install -g almightygpt

Use Node 18 or newer. The CLI is the shared engine behind terminal, VS Code, chat, MCP, and CI surfaces.

2. Set up provider keys

Terminal
> almightygpt auth

The guided auth flow opens provider key pages, accepts a hidden paste, validates with a real model-class call, and stores keys in the OS keychain.

Priority order
Explicit command input wins first, then environment variables, then OS keychain. VS Code uses SecretStorage and injects only scoped keys into CLI processes.

3. Initialize a repo

Terminal
> almightygpt init --stack next-js

Init refuses unsafe overwrites unless you choose --backup or --force. It also manages the host .gitignore entry for machine run metadata.

Current stack templates are node-ts, next-js, python-django, python-fastapi, rails, go.

4. Confirm generated files

AGENTS.mdCLAUDE.mdCODEX_AGENT.mdGEMINI_AGENT.md.almightyignore.almightygpt/config.yaml.almightygpt/rules.mddocs/codex-reviews/README.md

5. Run the first review

Terminal
> almightygpt review --diff --worker claude --reviewer codex --topic first-review

This reviews uncommitted changes by default. The Worker and Reviewer are separate roles, so one provider can plan or code while another checks the work.

6. Use the editor path

VS Code Chat
> @almightygpt /auth

Install the extension from VS Code Marketplace or Open VSX, open VS Code Chat, and try @almightygpt /auth. From there, use /review, /precommit, and /runs.