Skip to main content
Welcome to the NexusOne command-line tool documentation. This page explains how to deploy NexusOne with its command-line tool, and how to launch a JupyterHub environment to use other NexusOne command-line tools.

​
NexusOne deployment tool

shared_service_deployer.py is a command-line tool that deploys NexusOne into your cluster, so it runs before any JupyterHub server exists. Run it from a bastion host or your CI/CD pipeline with Kubernetes API access, never from inside JupyterHub. For the full command reference, refer to shared_service_deployer.py.

​
JupyterHub tools

JupyterHub in NexusOne comes preinstalled with two NexusOne command-line tools, nx1 and s3Cli. To use nx1 and s3Cli, you must first launch a JupyterHub environment. To launch one, take the following steps:
  1. Log in to NexusOne.
  2. On the NexusOne homepage, hover your mouse over Tools and then select Jupyter Notebook.
  3. Select the default profile.
  4. Click Start to launch JupyterHub. You should see a dedicated server getting assigned to you. This step might take some time.
After the server is successfully assigned to you, you can start using the nx1 or s3Cli tools. Each command abstracts and uses APIs to provide programmatic access to all NexusOne features that are accessible on the portal.