Skip to content

Commit 4ecda8c

Browse files
DOCS: add CLI section
1 parent fbfde72 commit 4ecda8c

File tree

1 file changed

+19
-0
lines changed

1 file changed

+19
-0
lines changed

README.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -187,3 +187,22 @@ deno task start --server full
187187
188188
> [!NOTE]
189189
> - To see all of the CLI options & usage see: [cli](#cli)
190+
191+
---
192+
193+
## CLI
194+
195+
- Incognito has a built in CLI for starting and running
196+
- Currently, there are only 4 flags.
197+
198+
- `--help` - This triggers the help prompt even when other flags are passed.
199+
- `--server [full|standalone]` - Choose between the full or standalone server. This option is ***required*** otherwise, it will just show the help prompt.
200+
- Full - Uses Fastify has a built in Wisp server (via [wisp server node](https://github.com/mercuryworkshop/wisp-server-node)) *(recommended for self hosters)*
201+
- Standalone - Uses Hono as the server with no built in Wisp server. *(recommended for a huge production instance with an external wisp server)*
202+
- These are the only two options. Anything else passed here WILL throw an error.
203+
- `--config <config path>` - Use a config located somewhere else.
204+
- Useful when using the [Pre-built binaries](#pre-built-binaries)
205+
- The path can either be absolute or relative.
206+
- `--seo` - Currently the default is to only use the build with no seo enabled. This flag enables the seo build.
207+
- Domain must be set in the [config](#config)
208+
- Overrides the enabled option in the [config](#config)

0 commit comments

Comments
 (0)