chore: drop billing and team variables from .env.example, add the installer README
.env.example described Stripe, Clerk, MinIO and the team server, none of which the community edition runs, and sent users to a Settings tab that does not exist. The web UI no longer names a person as author, and the installer package gets the README its files list promised.
This commit is contained in:
34
packages/launcher/README.md
Normal file
34
packages/launcher/README.md
Normal file
@@ -0,0 +1,34 @@
|
||||
# Waggle server installer
|
||||
|
||||
Installs and runs the Waggle server: the sidecar and web UI of the Waggle community edition,
|
||||
without the desktop app. The server runs on its own bundled Node, so nothing is compiled on
|
||||
your machine and no Python or Docker is needed.
|
||||
|
||||
```bash
|
||||
npx @waggle-ai/waggle install
|
||||
waggle-server
|
||||
```
|
||||
|
||||
`waggle-server` starts the server at http://localhost:3333 and opens it in your browser.
|
||||
|
||||
| Command | What it does |
|
||||
|---|---|
|
||||
| `install` | Downloads the server for this system, checks its SHA-256 and installs it |
|
||||
| `run` | Starts the server (the default command) |
|
||||
| `doctor` | Checks the runtime, SQLite, the data directory, the port and the command |
|
||||
| `update` | Installs this version over the installed one |
|
||||
| `uninstall` | Removes the program; your data stays |
|
||||
|
||||
Options: `--from <path|url>` installs from a downloaded archive, `--port <n>` picks another
|
||||
port, `--data-dir <path>` uses another data directory, `--no-open` keeps the browser closed.
|
||||
Run `waggle-server --help` for the full list.
|
||||
|
||||
Supported systems: Windows x64, macOS (Apple silicon and Intel), Linux x64. You need Node.js
|
||||
20 or newer only for the first `npx` call.
|
||||
|
||||
Your data lives in `~/.waggle` (or `WAGGLE_DATA_DIR`). `uninstall` does not touch it.
|
||||
|
||||
The package and command names are temporary until the product name is decided, and until
|
||||
the release location is set, install from an archive with `--from`.
|
||||
|
||||
License: MIT.
|
||||
Reference in New Issue
Block a user