nimblebox logo
Docs
v2.1.0

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

iconfunctionopen_home
[source]

Open current NBX platform

iconfunctionget
[source]
(api_end:str,no_pp:bool)
Parameters
  • api_end -

    something like '/v1/api'

  • no_pp -

    Pretty print. Defaults to False.

GET any API.

iconfunctionlogin
[source]

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

iconfunctionversion
[source]
iconfunctionwhy
[source]
iconfunctionmain
[source]

Classes

iconclassConfig
[source]
iconfunctionupdate
[source]

Set global config for nbox

iconfunctionshow
[source]

Pretty print global config for nbox

iconclassNBXWS_CLI
[source]
iconfunctionget
[source]

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

iconfunctionpost
[source]

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

nbox SDKnbox provides built in access to all the APIs and packages them in the most user friendly manner.Star 0