salvacybersec/feynman
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Clean up README: single install line, fix replicate descriptions

Browse Source 
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
This commit is contained in:
Advait Paliwal
2026-03-25 12:29:34 -07:00
parent 85e0c4d8c4
commit 572de7ba85
1 changed files with 2 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@@ -15,18 +15,8 @@
```bash ```bash
curl -fsSL https://feynman.is/install | bash curl -fsSL https://feynman.is/install | bash
# stable release channel
curl -fsSL https://feynman.is/install | bash -s -- stable
# package manager fallback
pnpm add -g @companion-ai/feynman
bun add -g @companion-ai/feynman
``` ```
The one-line installer tracks the latest `main` build. Use `stable` or an exact version to pin a release. Then run `feynman setup` to configure your model and get started.
--- ---
### What you type → what happens ### What you type → what happens
@@ -45,7 +35,7 @@ $ feynman audit 2401.12345
→ Compares paper claims against the public codebase → Compares paper claims against the public codebase
$ feynman replicate "chain-of-thought improves math" $ feynman replicate "chain-of-thought improves math"
→ Asks where to run, then builds a replication plan → Replicates experiments on local or cloud GPUs
``` ```
--- ---
@@ -60,7 +50,7 @@ Ask naturally or use slash commands as shortcuts.
| `/lit <topic>` | Literature review from paper search and primary sources | | `/lit <topic>` | Literature review from paper search and primary sources |
| `/review <artifact>` | Simulated peer review with severity and revision plan | | `/review <artifact>` | Simulated peer review with severity and revision plan |
| `/audit <item>` | Paper vs. codebase mismatch audit | | `/audit <item>` | Paper vs. codebase mismatch audit |
| `/replicate <paper>` | Replication plan with environment selection | | `/replicate <paper>` | Replicate experiments on local or cloud GPUs |
| `/compare <topic>` | Source comparison matrix | | `/compare <topic>` | Source comparison matrix |
| `/draft <topic>` | Paper-style draft from research findings | | `/draft <topic>` | Paper-style draft from research findings |
| `/autoresearch <idea>` | Autonomous experiment loop | | `/autoresearch <idea>` | Autonomous experiment loop |