Skip to content

Commit bc067a6

Browse files
staredavelanarius
authored andcommitted
readme further
1 parent 8cc2a3f commit bc067a6

File tree

1 file changed

+8
-14
lines changed

1 file changed

+8
-14
lines changed

README.md

Lines changed: 8 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -4,24 +4,19 @@
44

55
# `gradient-engineer` — 60‑Second Linux Analysis (Nix + LLM)
66

7-
Run the classic [60‑second Linux Performance Analysis](https://netflixtechblog.com/linux-performance-analysis-in-60-000-milliseconds-accc10403c55) checklist in one command on Linux (or macOS). It solves the `command not found` problem on minimal systems by downloading a portable [Nix](https://nixos.org/) toolbox on the fly. Diagnostics run in parallel with a simple TUI, and an optional AI summary is shown at the end.
7+
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:
88

99
- **One command**: Run the entire analysis with a single line.
10-
- **Fast**: Get a full system snapshot in about 6 seconds.
11-
- **Just works**: No sudo, no Docker, and no permanent installation.
12-
- **AI-powered summary**: Let an LLM explain the raw command outputs.
10+
- **Fast**: Completes the analysis in about 6 seconds.
11+
- **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.
12+
- **No dependencies**: Requires no `sudo`, Docker, or permanent installation.
13+
- **AI Summary**: Provides an optional, human-readable summary of the results.
1314

1415
More details in the blog post: [60-Second Linux Analysis with Nix and LLMs](https://quesma.com/blog/60s-linux-analysis-nix-llms/).
1516

1617
> [!NOTE]
1718
> This project is an early experiment.
1819
19-
## Why? The `command not found` Nightmare
20-
21-
You SSH into a server to troubleshoot an issue, run a standard tool like `iostat`, and are greeted with `command not found`. Minimal container images and server installations often lack essential diagnostic tools. Installing them during an outage is a waste of precious time and can be blocked by firewalls, package manager issues, or immutable filesystems.
22-
23-
`gradient-engineer` solves this by providing a portable, on-demand toolbox with all the necessary utilities, powered by [Nix](https://nixos.org/). It runs the tools you need without requiring root access or permanent changes to the system.
24-
2520
## Quick Start
2621

2722
Run the following command in your terminal. It works on both Linux and macOS.
@@ -30,7 +25,7 @@ Run the following command in your terminal. It works on both Linux and macOS.
3025
curl -fsSL https://gradient.engineer/60-second-linux.sh | sh
3126
```
3227

33-
To enable the optional AI summary, set an API key from a supported provider _before_ running the script:
28+
To enable the optional AI summary, set an API key _before_ running the script:
3429

3530
```bash
3631
export ANTHROPIC_API_KEY="<your Anthropic API key>" # OR
@@ -40,9 +35,8 @@ export OPENROUTER_API_KEY="<your OpenRouter API key>"
4035

4136
**Notes:**
4237

43-
- If no key is set, diagnostics still run; only the AI summary is skipped.
44-
- You can override the API base URL via `OPENAI_BASE_URL` (for OpenAI/OpenRouter).
45-
- TUI controls: `Tab` toggles details; `q` / `Esc` / `Ctrl+C` quits.
38+
- If no key is set, the AI summary is skipped.
39+
- Use `Tab` to toggle details in the TUI; `q` / `Esc` / `Ctrl+C` quits.
4640

4741
## Demo
4842

0 commit comments

Comments
 (0)