Promote native installer in website docs

This commit is contained in:
Advait Paliwal
2026-03-24 12:06:42 -07:00
parent 1c90128605
commit ee9eb3a053
2 changed files with 22 additions and 7 deletions

View File

@@ -7,13 +7,13 @@ order: 1
## Requirements ## Requirements
- Node.js 20 or later - macOS, Linux, or WSL
- npm 9 or later - `curl` or `wget`
## Install ## Recommended install
```bash ```bash
npm install -g @companion-ai/feynman curl -fsSL https://raw.githubusercontent.com/getcompanion-ai/feynman/main/scripts/install/install.sh | bash
``` ```
## Verify ## Verify
@@ -22,6 +22,20 @@ npm install -g @companion-ai/feynman
feynman --version feynman --version
``` ```
## Windows PowerShell
```powershell
irm https://raw.githubusercontent.com/getcompanion-ai/feynman/main/scripts/install/install.ps1 | iex
```
## npm fallback
If you already manage Node yourself:
```bash
npm install -g @companion-ai/feynman
```
## Local Development ## Local Development
For contributing or local development: For contributing or local development:

View File

@@ -9,12 +9,13 @@ import AsciiLogo from '../components/AsciiLogo.astro';
<AsciiLogo size="hero" class="mb-4" /> <AsciiLogo size="hero" class="mb-4" />
<h1 class="text-5xl sm:text-6xl font-bold tracking-tight mb-6" style="text-wrap: balance">The open source AI research agent</h1> <h1 class="text-5xl sm:text-6xl font-bold tracking-tight mb-6" style="text-wrap: balance">The open source AI research agent</h1>
<p class="text-lg text-text-muted mb-10 leading-relaxed" style="text-wrap: pretty">Investigate topics, write papers, run experiments, review research, audit codebases &mdash; every output cited and source-grounded</p> <p class="text-lg text-text-muted mb-10 leading-relaxed" style="text-wrap: pretty">Investigate topics, write papers, run experiments, review research, audit codebases &mdash; every output cited and source-grounded</p>
<div class="inline-flex items-center gap-3 bg-surface rounded-lg px-5 py-3 mb-8 font-mono text-sm"> <div class="inline-flex items-center gap-3 bg-surface rounded-lg px-5 py-3 mb-3 font-mono text-sm">
<code class="text-accent">npm install -g @companion-ai/feynman</code> <code class="text-accent">curl -fsSL https://raw.githubusercontent.com/getcompanion-ai/feynman/main/scripts/install/install.sh | bash</code>
<button id="copy-btn" class="text-text-dim hover:text-accent transition-colors focus-visible:outline-none focus-visible:ring-2 focus-visible:ring-accent rounded" aria-label="Copy install command"> <button id="copy-btn" class="text-text-dim hover:text-accent transition-colors focus-visible:outline-none focus-visible:ring-2 focus-visible:ring-accent rounded" aria-label="Copy install command">
<svg class="w-4 h-4" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2"><rect x="9" y="9" width="13" height="13" rx="2" /><path d="M5 15H4a2 2 0 0 1-2-2V4a2 2 0 0 1 2-2h9a2 2 0 0 1 2 2v1" /></svg> <svg class="w-4 h-4" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2"><rect x="9" y="9" width="13" height="13" rx="2" /><path d="M5 15H4a2 2 0 0 1-2-2V4a2 2 0 0 1 2-2h9a2 2 0 0 1 2 2v1" /></svg>
</button> </button>
</div> </div>
<p class="text-sm text-text-dim mb-8">Native installer recommended for macOS, Linux, and WSL. npm remains available as a fallback.</p>
<div class="flex gap-4 justify-center flex-wrap"> <div class="flex gap-4 justify-center flex-wrap">
<a href="/docs/getting-started/installation" class="px-6 py-2.5 rounded-lg bg-accent text-bg font-semibold text-sm hover:bg-accent-hover transition-colors focus-visible:outline-none focus-visible:ring-2 focus-visible:ring-accent focus-visible:ring-offset-2 focus-visible:ring-offset-bg">Get started</a> <a href="/docs/getting-started/installation" class="px-6 py-2.5 rounded-lg bg-accent text-bg font-semibold text-sm hover:bg-accent-hover transition-colors focus-visible:outline-none focus-visible:ring-2 focus-visible:ring-accent focus-visible:ring-offset-2 focus-visible:ring-offset-bg">Get started</a>
<a href="https://github.com/getcompanion-ai/feynman" target="_blank" rel="noopener" class="px-6 py-2.5 rounded-lg border border-border text-text-muted font-semibold text-sm hover:border-text-dim hover:text-text-primary transition-colors focus-visible:outline-none focus-visible:ring-2 focus-visible:ring-accent focus-visible:ring-offset-2 focus-visible:ring-offset-bg">GitHub</a> <a href="https://github.com/getcompanion-ai/feynman" target="_blank" rel="noopener" class="px-6 py-2.5 rounded-lg border border-border text-text-muted font-semibold text-sm hover:border-text-dim hover:text-text-primary transition-colors focus-visible:outline-none focus-visible:ring-2 focus-visible:ring-accent focus-visible:ring-offset-2 focus-visible:ring-offset-bg">GitHub</a>
@@ -150,7 +151,7 @@ import AsciiLogo from '../components/AsciiLogo.astro';
<script is:inline> <script is:inline>
document.getElementById('copy-btn').addEventListener('click', function() { document.getElementById('copy-btn').addEventListener('click', function() {
navigator.clipboard.writeText('npm install -g @companion-ai/feynman'); navigator.clipboard.writeText('curl -fsSL https://raw.githubusercontent.com/getcompanion-ai/feynman/main/scripts/install/install.sh | bash');
this.innerHTML = '<svg class="w-4 h-4" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2"><path d="M20 6L9 17l-5-5"/></svg>'; this.innerHTML = '<svg class="w-4 h-4" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2"><path d="M20 6L9 17l-5-5"/></svg>';
var btn = this; var btn = this;
setTimeout(function() { setTimeout(function() {