Add npm install option to website
This commit is contained in:
@@ -1,11 +1,11 @@
|
|||||||
---
|
---
|
||||||
title: Installation
|
title: Installation
|
||||||
description: Install Feynman on macOS, Linux, or Windows using the standalone installer.
|
description: Install Feynman on macOS, Linux, or Windows with curl or npm.
|
||||||
section: Getting Started
|
section: Getting Started
|
||||||
order: 1
|
order: 1
|
||||||
---
|
---
|
||||||
|
|
||||||
Feynman ships as a standalone runtime bundle for macOS, Linux, and Windows. The one-line installer downloads a prebuilt native bundle with zero external runtime dependencies.
|
Feynman can be installed either as a standalone runtime bundle or as an npm package. For most users, the standalone installer is the simplest path because it downloads a prebuilt native bundle with zero external runtime dependencies.
|
||||||
|
|
||||||
## One-line installer (recommended)
|
## One-line installer (recommended)
|
||||||
|
|
||||||
@@ -27,16 +27,38 @@ irm https://feynman.is/install.ps1 | iex
|
|||||||
|
|
||||||
This installs the Windows runtime bundle under `%LOCALAPPDATA%\Programs\feynman`, adds its launcher to your user `PATH`, and lets you re-run the installer at any time to update.
|
This installs the Windows runtime bundle under `%LOCALAPPDATA%\Programs\feynman`, adds its launcher to your user `PATH`, and lets you re-run the installer at any time to update.
|
||||||
|
|
||||||
|
## Alternative: npm install
|
||||||
|
|
||||||
|
If you prefer installing Feynman into an existing Node.js environment, use npm instead:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
npm install -g @companion-ai/feynman
|
||||||
|
```
|
||||||
|
|
||||||
|
This path uses your local Node.js runtime instead of the bundled standalone runtime. It requires a compatible Node.js version that satisfies Feynman's current engine range: `>=20.19.0 <25`.
|
||||||
|
|
||||||
## Updating the standalone app
|
## Updating the standalone app
|
||||||
|
|
||||||
To update the standalone Feynman app on macOS, Linux, or Windows, rerun the installer you originally used. That replaces the downloaded runtime bundle with the latest tagged release.
|
To update the standalone Feynman app on macOS, Linux, or Windows, rerun the installer you originally used. That replaces the downloaded runtime bundle with the latest tagged release.
|
||||||
|
|
||||||
`feynman update` is different: it updates installed Pi packages inside Feynman's environment, not the standalone app bundle itself.
|
`feynman update` is different: it updates installed Pi packages inside Feynman's environment, not the standalone app bundle itself.
|
||||||
|
|
||||||
|
If you installed Feynman with npm, upgrade it with:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
npm install -g @companion-ai/feynman@latest
|
||||||
|
```
|
||||||
|
|
||||||
## Uninstalling
|
## Uninstalling
|
||||||
|
|
||||||
Feynman does not currently ship a dedicated `uninstall` command. Remove the standalone launcher and runtime bundle directly, then optionally remove the Feynman home directory if you also want to delete settings, sessions, and installed package state. If you also want to clear alphaXiv login state, remove `~/.ahub`.
|
Feynman does not currently ship a dedicated `uninstall` command. Remove the standalone launcher and runtime bundle directly, then optionally remove the Feynman home directory if you also want to delete settings, sessions, and installed package state. If you also want to clear alphaXiv login state, remove `~/.ahub`.
|
||||||
|
|
||||||
|
If you installed Feynman with npm, uninstall it with:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
npm uninstall -g @companion-ai/feynman
|
||||||
|
```
|
||||||
|
|
||||||
On macOS or Linux:
|
On macOS or Linux:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
@@ -123,15 +145,3 @@ feynman --version
|
|||||||
```
|
```
|
||||||
|
|
||||||
If you see a version number, you are ready to go. Run `feynman doctor` at any time to diagnose configuration issues, missing dependencies, or authentication problems.
|
If you see a version number, you are ready to go. Run `feynman doctor` at any time to diagnose configuration issues, missing dependencies, or authentication problems.
|
||||||
|
|
||||||
## Local development
|
|
||||||
|
|
||||||
For contributing or running Feynman from source:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
git clone https://github.com/getcompanion-ai/feynman.git
|
|
||||||
cd feynman
|
|
||||||
nvm use || nvm install
|
|
||||||
npm install
|
|
||||||
npm start
|
|
||||||
```
|
|
||||||
|
|||||||
@@ -45,6 +45,7 @@ const terminalCommands = [
|
|||||||
|
|
||||||
const installCommands = [
|
const installCommands = [
|
||||||
{ label: "curl", command: "curl -fsSL https://feynman.is/install | bash" },
|
{ label: "curl", command: "curl -fsSL https://feynman.is/install | bash" },
|
||||||
|
{ label: "npm", command: "npm install -g @companion-ai/feynman" },
|
||||||
]
|
]
|
||||||
---
|
---
|
||||||
|
|
||||||
@@ -102,6 +103,10 @@ const installCommands = [
|
|||||||
</a>
|
</a>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
<p class="text-sm text-muted-foreground">
|
||||||
|
Use curl for the bundled runtime, or npm if you already manage Node locally.
|
||||||
|
</p>
|
||||||
|
|
||||||
<p class="text-sm text-muted-foreground">
|
<p class="text-sm text-muted-foreground">
|
||||||
Need just the skills? <a href="/docs/getting-started/installation" class="text-primary hover:underline">Install the skills-only bundle</a>.
|
Need just the skills? <a href="/docs/getting-started/installation" class="text-primary hover:underline">Install the skills-only bundle</a>.
|
||||||
</p>
|
</p>
|
||||||
|
|||||||
Reference in New Issue
Block a user