The server commands
Start, stop and inspect the local Archboard server that the other commands talk to.
Every command below comes from the CLI's own contract in release 0.5.0.
Run archboard help <command> for the same words at your
terminal.
| Command | What it does |
|---|---|
start
|
Start the Archboard server (detached) |
stop
|
Stop the Archboard server |
restart
|
Stop the Archboard server, build the frontend and start it again |
status
|
Archboard server health and browser clients |
start #
Start the Archboard server (detached)
- Writes files
Synopsis
archboard start [--url <url>]
Explicitly starts the local Archboard server, overriding an ARCHBOARD_NO_AUTOSTART=1 opt-out of automatic start.
Arguments
| Argument | What it does |
|---|---|
--url <url>
|
The Archboard server to talk to; overrides ARCHBOARD_URL
Default http://127.0.0.1:4242.
|
Examples
archboard startOutput
- Server startup state
Exit codes
| Exit | When |
|---|---|
| 0 | Success The command did what it said. Its output is above. |
Refusals
| Exit | Refusal |
|---|---|
| 3 |
SERVER_UNREACHABLE
The explicitly started server did not become healthy.
|
stop #
Stop the Archboard server
- Writes files
Synopsis
archboard stop [--url <url>]
Stops only a live process that identifies itself as this Archboard server.
Arguments
| Argument | What it does |
|---|---|
--url <url>
|
The Archboard server to talk to; overrides ARCHBOARD_URL
Default http://127.0.0.1:4242.
|
Examples
archboard stopOutput
- Identity-safe stop result
Exit codes
| Exit | When |
|---|---|
| 0 | Success The command did what it said. Its output is above. |
Refusals
It has no refusals of its own. The exit codes of every command apply.
restart #
Stop the Archboard server, build the frontend and start it again
- Writes files
Synopsis
archboard restart [--url <url>]
Stops the server as stop does, builds the frontend of this checkout, and starts the server as start does, so the server runs the source and serves the bundle that are on disk now.
Arguments
| Argument | What it does |
|---|---|
--url <url>
|
The Archboard server to talk to; overrides ARCHBOARD_URL
Default http://127.0.0.1:4242.
|
Examples
archboard restartOutput
- The stop, the new bundle and the started server
Exit codes
| Exit | When |
|---|---|
| 0 | Success The command did what it said. Its output is above. |
Refusals
| Exit | Refusal |
|---|---|
| 3 |
SERVER_UNREACHABLE
The server could not be started again, so nothing was stopped, or the started server did not become healthy.
|
| 1 |
FRONTEND_BUILD_FAILED
The frontend build failed after the stop. The server stays stopped.
|
status #
Archboard server health and browser clients
- Reads only
Synopsis
archboard status [--url <url>]
Reports Archboard server availability, identity, source freshness, and synchronization state.
Arguments
| Argument | What it does |
|---|---|
--url <url>
|
The Archboard server to talk to; overrides ARCHBOARD_URL
Default http://127.0.0.1:4242.
|
Examples
archboard statusOutput
- Archboard server status
Exit codes
| Exit | When |
|---|---|
| 0 | Success The command did what it said. Its output is above. |
| 3 | unavailable No Archboard server is answering at the configured URL. |
| 3 | foreign-service Another service, an incompatible Archboard server or a server of another checkout's source is answering. |
Refusals
It has no refusals of its own. The exit codes of every command apply.