nbox.cli

This is CLI for nbox, it is meant to be as simple to use as possible. We using python-fire for building our CLI, which means you can access underlying system with same commands as you use with python.

SSH into Instances

You can SSH into your instance with the nbx tunnel command. This command will create a tunnel to your instance and start an SSH session.

nbx tunnel 8000 -i "instance-id"

Functions

functionopen_home

[source]

Open current NBX platform

functionget

[source]

(api_end:str,no_pp:bool)

Parameters

• api_end -

  something like '/v1/api'

• no_pp -

  Pretty print. Defaults to False.

GET any API.

functionlogin

[source]

Re authenticate nbox. NOTE: Will remove all added keys to secrets

functionversion

[source]

functionwhy

[source]

functionmain

[source]

Classes

classConfig

[source]

functionupdate

[source]

Set global config for nbox

functionshow

[source]

Pretty print global config for nbox

functionclear

[source]

classNBXWS_CLI

[source]

functionget

[source]

make a GET call to any api, it can either contain '/' or '.'

functionpost

[source]

make a POST call to any api, it can either contain '/' or '.'