@northflank/cli-temp v0.0.14

Northflank Command Line Interface (CLI)

Provides a command-line interface to the Northflank platform.

WARNING: This package is in beta status and subject to frequent changes. In case you encounter any bugs, errors or issues, feel free to contact us here https://northflank.com/contact

More info on www.northflank.com

Full documentation on docs.northflank.com

Installation

Install with npm i @northflank/cli -g or yarn global add @northflank/cli if you're using yarn.

This allows to use the CLI globally from the command line.

To use without installation, run npx @northflank/cli

Usage

The command northflank help provides useful information in navigating the various commands of the CLI.

Login

Run the login command to connect the CLI to your northflank account:

northflank login

This creates a context, which will be used as a default for further use of the CLI.

Having logged in, the CLI is ready to be used.

Examples

• Listing services in a project: northflank list services
• Getting detailed information about a service: northflank get service details
• Scaling a service: northflank scale service
• Creating a combined service: northflank create combinedService

Contexts

Contexts can be used to cache auth info, default projects and services:

• northflank contexts use project
• northflank contexts use service
• List all context and defaults: northflank contexts list
• Switch between contexts: northflank context use

Forwarding Northflank Services and Addons

Northflank services and addons can be exposed locally using the northflank forward command. Examples:

• sudo northflank forward all
• sudo northflank forward addon --addon <addon-id>
• sudo northflank forward service --service <service-id>

Please not that this command requires root/admin privilges

Interactive Mode

The CLI will ask for the required information when executing a command if the information is not provided by command line arguments or input files. This is done in a beginner-friendly question-answer style of interacting and allows for CLI exploration.

After having provided all required information, the user can choose to run through the questions again or edit the final command payload for full flexibility. The request can also be saved to a file and be used in the future using the --file <file-path> flag.