​

Usage

​

Creating a new project

nf new

​

Commands

• build
• create
• dev
• editor
• generate
• install/add
• login
• logout
• new
• publish
• start
• unpublish

​

build

• -d, --directory <directory> specify the working directory of the command.
• -c, --config <config> path to the config file. (Schema)
• --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.
• --server-static-dir <serverStaticDir> specify the static directory of the server.
• --client-out-dir <clientOutDir> specify the output directory of the client.
• --server-out-dir <serverOutDir> specify the output directory of the server.
• --editor build with editor config.
• --watch build app in watching mode. (default: false)

​

create

• <type> the type to create (component or system).
• -d, --directory <directory> specify the working directory of the command.
• -c, --config <config> path to the config file. (Schema)
• -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.

​

dev

• -d, --directory <directory> specify the working directory of the command.
• -c, --config <config> path to the config file. (Schema)
• --generate generate app files from config, like generate command in dev mode. (default: false)

​

editor

• [path] path to the project to open in the 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.

​

generate

• -d, --directory <directory> specify the working directory of the command.
• -c, --config <config> path to the config file. (Schema)
• --editor generate the editor main file.
• --watch generate app in watching mode. (default: false)

​

install/add

• [names...] names of the components/systems/libraries to install.
• -d, --directory <directory> specify the working directory of the command.
• -l, --lib install a library instead of a component/system. (default: false)
• -s, --server install on server instead of client. (default: false)

​

login

• -d, --directory <directory> specify the working directory of the command.
• -l, --local log in only for the current project. (default: false)
• -k, --api-key <key> API key for the Nanoforge registry.

​

logout

• -d, --directory <directory> specify the working directory of the command.
• -l, --local log out only for the current project.

​

new

• -d, --directory <directory> specify the working directory of the command.
• --name <name> specify the name of your project.
• --path <path> specify the relative path where your project will be created (default: name of the project).
• --package-manager <packageManager> specify the package manager of your project.
• --language <language> specify the language of your project.
• --strict use strict mode.
• --no-strict do not use strict mode.
• --server create a server.
• --no-server do not create a server.
• --init-functions initialize functions.
• --no-init-functions do not initialize functions.
• --skip-install skip installing dependencies.
• --no-skip-install do not skip installing dependencies.
• --docker generate docker files.
• --no-docker do not generate docker files.
• --no-lint do not generate lint files.
• --editor add editor dependencies.
• --git generate a git repository.
• --no-git do not generate a git repository.
• --git-remote <gitRemote> set up a git remote (required if --git is used).
• --no-git-remote do not set up a git remote.

​

publish

• -d, --directory <directory> specify the working directory of the command.

​

start

• -d, --directory <directory> specify the working directory of the command.
• -c, --config <config> path to the config file (default: “nanoforge.config.json”). (Schema)
• -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.
• --watch run app in watching mode. (default: false)
• --cert <cert> path to the SSL certificate for HTTPS.
• --key <key> path to the SSL key for HTTPS.

​

unpublish

• -d, --directory <directory> specify the working directory of the command.

​

Environment Variables

NANOFORGE_CLIENT_SERVER_TCP_PORT=4445
NANOFORGE_CLIENT_SERVER_UDP_PORT=4444
NANOFORGE_CLIENT_SERVER_ADDRESS=127.0.0.1

Note: Prefixes are stripped before the variable is exposed to libraries.