All apps/Northflank CLI

Northflank CLI

northflank

Provides a command-line interface to the Northflank platform.

Runs as northflank, nf|macOS, Linux, Windows|northflank.com

Command form

ai-draft · 4 tasks · 23 fields

Global options only; use the subcommands for the most common service operations.

Opens the form; the finished command lands at your prompt, unrun
otty gui northflank

northflank list services

List services

List services in a project.

List servicesExample values, fixed in this page — nothing here reaches a terminal
Basic
Project ID
string
Output
string
TasksEach one presets the form for one job
List services
projectoutput
ParametersOnly these flags are editable in the form
Project ID
string
--project--projectId
Output
string
-o--outputjsonyaml
Ignore context defaults
boolean
--noDefaults
Verbose
boolean
--verbose
Quiet
boolean
--quiet

northflank get service

Get service

Show information about one service.

Get serviceExample values, fixed in this page — nothing here reaches a terminal
Basic
Project ID
string
Service ID*
string
Output
string
TasksEach one presets the form for one job
Get service
projectserviceoutput
ParametersOnly these flags are editable in the form
Project ID
string
--project--projectId
Service ID
string
--service--serviceId
Output
string
-o--outputjsonyaml
Ignore context defaults
boolean
--noDefaults
Verbose
boolean
--verbose
Quiet
boolean
--quiet

northflank restart service

Restart service

Restart a service.

Restart serviceExample values, fixed in this page — nothing here reaches a terminal
Basic
Project ID
string
Service ID*
string
TasksEach one presets the form for one job
Restart service
projectservice
ParametersOnly these flags are editable in the form
Project ID
string
--project--projectId
Service ID
string
--service--serviceId
Output
string
-o--outputjsonyaml
Ignore context defaults
boolean
--noDefaults
Verbose
boolean
--verbose
Quiet
boolean
--quiet

northflank forward service

Forward service

Port-forward a service locally.

Forward serviceExample values, fixed in this page — nothing here reaches a terminal
Basic
Project ID
string
Service
string
Skip hostnames (no root)
--skipHostnames
TasksEach one presets the form for one job
Forward service
projectserviceskip_hostnames
ParametersOnly these flags are editable in the form
Project ID
string
--project--projectId
Service
string
--service--serviceId
Skip hostnames (no root)
boolean
--skipHostnames
Ignore context defaults
boolean
--noDefaults
Verbose
boolean
--verbose
Quiet
boolean
--quiet
SourcesEvery flag above is checked against these
fig
completion

github.com

fig
completion

github.com

fig
completion

github.com

fig
completion

github.com

fig
completion

github.com

Before it fills your prompt, Otty checks the installed northflank against its version. A form that does not match your version is not offered.