diff --git a/README.md b/README.md index 573b0f6..4e696af 100644 --- a/README.md +++ b/README.md @@ -4,48 +4,63 @@ # `gradient-engineer` — 60‑Second Linux Analysis (Nix + LLM) -Run the classic [“60‑second Linux Performance Analysis”](https://netflixtechblog.com/linux-performance-analysis-in-60-000-milliseconds-accc10403c55) checklist in one command. A portable Nix toolbox is downloaded on the fly, diagnostics run in parallel with a simple TUI, and an optional AI summary is shown at the end. +Run the classic [60‑second Linux Performance Analysis](https://netflixtechblog.com/linux-performance-analysis-in-60-000-milliseconds-accc10403c55) checklist on Linux or macOS. This tool enhances the original playbook with a few key improvements: -- One command to run it all -- Fast and portable -- No Docker, no system‑wide installs -- Optional AI summary +- **One command**: Run the entire analysis with a single line. +- **Fast**: Completes the analysis in about 6 seconds. +- **Solves `command not found`**: Downloads a portable [Nix](https://nixos.org/) toolbox on the fly, so you don't need to install missing tools like `iostat` during a crisis. +- **No dependencies**: Requires no `sudo`, Docker, or permanent installation. +- **AI Summary**: Provides an optional, human-readable summary of the results. + +More details in the blog post: [60-Second Linux Analysis with Nix and LLMs](https://quesma.com/blog/60s-linux-analysis-nix-llms/). > [!NOTE] > This project is an early experiment. ## Quick Start -```bash -# Any provider works; set one of these env vars to enable AI summary -export ANTHROPIC_API_KEY="" # Anthropic -export OPENAI_API_KEY="" # OpenAI -export OPENROUTER_API_KEY="" # OpenRouter +Run the following command in your terminal. It works on both Linux and macOS. +```bash curl -fsSL https://gradient.engineer/60-second-linux.sh | sh ``` -Notes: +To enable the optional AI summary, set an API key _before_ running the script: + +```bash +export ANTHROPIC_API_KEY="" # OR +export OPENAI_API_KEY="" # OR +export OPENROUTER_API_KEY="" +``` + +**Notes:** -- If no key is set, diagnostics still run; only the AI summary is skipped. -- TUI controls: Tab toggles details; q / Esc / Ctrl+C quits. +- If no key is set, the AI summary is skipped. +- Use `Tab` to toggle details in the TUI; `q` / `Esc` / `Ctrl+C` quits. -## Demo - See It in Action! +## Demo [![asciicast](https://asciinema.org/a/738144.svg)](https://asciinema.org/a/738144) ## Build from Source +Requires [Go 1.25 or newer](https://go.dev/). + ```bash -cd app +git clone https://github.com/QuesmaOrg/gradient-engineer.git +cd gradient-engineer/app go build -o gradient-engineer-go -./gradient-engineer-go 60-second-linux +./gradient-engineer-go ``` ## Advanced - You can override the API base URL via `OPENAI_BASE_URL` (for OpenAI/OpenRouter) if needed. +## Contributing + +This is an early prototype, and we're just getting started. The repository is open-source, and we're excited to explore what's possible. Have a look at the current [playbooks](./playbook/). We started with the classic, but we bet you have your own favorite commands—feel free to contribute them! + ## License This project is licensed under the MIT License. See the `LICENSE` file for details.