Skip to content

docs: make the README command options match the commands #289

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
tylrcc wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: make the README command options match the commands #289

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 6 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,6 @@ nf [command] [options]
Used to build your nanoforge project.

- `-d, --directory <directory>` specify the working directory of the command.
- `-c, --config <config>` path to the config file.
- `--client-entry <clientEntry>` specify the entry file of the client.
- `--server-entry <serverEntry>` specify the entry file of the server.
- `--client-static-dir <clientStaticDir>` specify the static directory of the client.
Expand All @@ -76,17 +75,17 @@ nf create plugin --name @acme/forest --template theme # a color theme, no code

- `<type>` the type to create (component, system or plugin).
- `-d, --directory <directory>` specify the working directory of the command.
- `-c, --config <config>` path to the config file.
- `-n, --name <name>` name of the component/system.
- `-s, --server` create on server instead of client. (default: `false`)
- `-p, --path <path>` path to the component/system folder.
- `-n, --name <name>` name of the component/system, or @scope/name of the plugin.
- `-p, --path <path>` path to the component/system folder (default: <part>/<components|systems>), or the folder of the new plugin (default: its name).
- `-t, --template <template>` what a plugin starts from: panel (a panel, a command and a setting) or theme (a color theme, no code).

### `dev`

Used to run your nanoforge project in dev mode.

- `-d, --directory <directory>` specify the working directory of the command.
- `-c, --config <config>` path to the config file.
- `-e, --editor` run the editor.

### `editor`

Expand All @@ -96,6 +95,7 @@ Used to start the nanoforge editor.
- `-d, --directory <directory>` specify the working directory of the command.
- `--open` open the editor in the default web browser (default: `true` if path is specified, `false` otherwise).
- `--no-open` do not open the editor in the default web browser.
- `-p, --port <port>` port of the editor (default: 5173).

### `install` or `add`

Expand Down Expand Up @@ -159,7 +159,6 @@ Used to publish a package to the NanoForge registry: zips what its `nanoforge.ma
Used to start your nanoforge project.

- `-d, --directory <directory>` specify the working directory of the command.
- `-c, --config <config>` path to the config file (default: "nanoforge.config.json").
- `-p, --port <port>` specify the port of the loader (the website to load the game).
- `--client-dir <clientDirectory>` specify the directory of the client.
- `--server-dir <serverDirectory>` specify the directory of the server.
Expand Down Expand Up @@ -209,4 +208,4 @@ If you don't understand something in the documentation, you are experiencing pro
[github-releases]: https://github.com/NanoForge-dev/CLI/releases
[good-first-issue]: https://github.com/NanoForge-dev/CLI/contribute

The config file schema can be found at : [https://nanoforge-dev.github.io/docs/cli/config-schema.json](https://nanoforge-dev.github.io/docs/cli/config-schema.json)
The config file schema can be found at : [https://docs.nanoforge.eu/docs/cli/config.schema.json](https://docs.nanoforge.eu/docs/cli/config.schema.json)
Loading