Corlink Server CLI
This is the documentation for the Corlink API Server's CLI commands and options.
Prerequisites
- A working Corlink API Server instance. (You can find the documentation here)
Commands
Start
This command is used to start the Corlink API Server.
Usage
corlink-server start
Options
| Flag | Short Flag | Description | Default | Usage | Short Usage |
|---|---|---|---|---|---|
--port | -p | The port the server should run on. | 8080 | --port 8080 | -p 8080 |
--host | -H | The host the server should run on. | 0.0.0.0 | --host localhost | -H localhost |
--sqlite | -s | Use SQLite instead of PostgreSQL. | false | --sqlite | -s |
--directory | -d | Listen on a subdirectory. | / | --directory /corlink | -d /corlink |
Example
corlink-server start -p 8080 -H localhost -s
This will start the Corlink API Server on port 8080 and host localhost using SQLite instead of PostgreSQL.