cli-serve

Files (1)

• SKILL.md

SKILL.md (first lines)

<!-- generated by src/lib/agentSkills/generator.ts; manual edits will be overwritten -->

## Overview

Start, stop, and restart the NextRoute server from the CLI. Manage daemon mode, port configuration, auto-recovery, system tray integration, and the dashboard open shortcut.

## Quick install

```bash
npm install -g nextroute   # or: npx nextroute
nextroute --version
```

## Subcommands

### `dashboard`

**Flags:**

- `--url`
- `--port <port>`
- `--tui`

**Example:**

```bash
nextroute dashboard
```

### `restart`

**Flags:**

- `--port <port>`

**Example:**

```bash
nextroute restart
```

### `serve`

**Flags:**

- `--port <port>`
- `--no-open`
- `--daemon`
- `--log`
- `--no-recovery`
- `--max-restarts <n>`
- `--tray`
- `--no-tray`

**Example:**

```bash
nextroute serve
```

### `stop`

**Example:**

```bash
nextroute stop
```

<!-- skill:custom-start -->
<!-- Aggregated from: nextroute-cli (setup + index), nextroute-cli-admin (lifecycle/setup/backup/tunnel) -->

## Setup

The `nextroute` binary ships with the NextRoute server. It is both the server launcher and a full management CLI with 250+ commands across 39 groups.

### Install

```bash
npm install -g nextroute          # npm registry
# or: use the binary bundled with the desktop app
```

Requires Node.js ≥20.20.2, ≥22.22.2, or ≥24.

Verify:

```bash
nextroute --version   # prints installed version
nextroute --help      # full command tree
```

### Connection

Every CLI command that talks to the server reads two values:

| Source   | Variable / Flag                      |
| -------- | ------------------------------------ |
| Base URL | `NEXTROUTE_BASE_URL` or `--base-url` |
| API key  | `NEXTROUTE_API_KEY` or `--api-key`   |

Default base URL: `http://localhost:20128`

```bash
export NEXTROUTE_BASE_URL="http://localhost:20128"
export NEXTROUTE_API_KEY="sk-..."          # from Dashboard → API Manager
```

For a remote server:

```bash
export NEXTROUTE_BASE_URL="https://your-server.com"
```

### Global flags

| Flag                | Description                                              |
| ------------------- | -------------------------------------------------------- |
| `--base-url <url>`  | Override server URL for this invocation                  |
| `--api-key <key>`   | Override API key for this invocation                     |
| `--output <format>` | Output format: `table` (default), `json`, `jsonl`, `csv` |

From DevMHOne/nextroute, MIT.

More from DevMHOne/nextroute