Skip to content
GigadriveDocs

CLI

Install the gigadrive command line client, learn the two binary names, and see the options every command accepts.

The gigadrive client deploys the current directory to Gigadrive Network and manages the applications, environment variables and deployments behind it. Use it when you want a deploy in a script instead of a click in the console.

Install

The CLI needs Node.js 20 or newer.

npm install -g gigadrive

Or run it without installing anything:

pnpm dlx gigadrive deploy

The npm package is named gigadrive and it installs two binaries, gigadrive and gn. Both point at the same file, so every example on these pages works under either name:

gn deploy

Check what you have with gigadrive --version.

Global options

Every command and subcommand accepts the same five options.

OptionAliasDescription
--help-hShow the help documentation for a command.
--versionShow the version of the application.
--wizardStart wizard mode for a command.
--completions <shell>Generate a completion script for sh, bash, fish or zsh.
--log-level <level>Sets the minimum log level for a command.

--help answers at every level. gigadrive --help lists the commands, gigadrive env --help lists the env subcommands, and gigadrive env pull --help documents that one command.

--log-level accepts all, trace, debug, info, warning, error, fatal and none, and starts at info. Raise it to debug when a deploy does something the printed output does not explain, or drop it to none for quiet CI logs.