config

Client configuration

Usage

neuro config [OPTIONS] COMMAND [ARGS]...

Client configuration.

Commands:

Usage	Description
aliases	List available command aliases
docker	Configure local docker client
get-clusters	List available clusters/org pairs
login	Log into Neuro Platform
login-headless	Log into Neuro Platform in non-GUI environ
login-with-token	Log into Neuro Platform with token
logout	Log out
show	Print current settings
show-token	Print current authorization token
switch-cluster	Switch the active cluster
switch-org	Switch the active organization
switch-project	Switch the active project

aliases

List available command aliases

Usage

neuro config aliases [OPTIONS]

List available command aliases.

Options

Name	Description
--help	Show this message and exit.

docker

Configure local docker client

Usage

neuro config docker [OPTIONS]

Configure local docker client

This command configures local docker client to use Neuro Platform's docker registry.

Options

Name	Description
--help	Show this message and exit.
--docker-config PATH	Specifies the location of the Docker client configuration files

get-clusters

List available clusters/org pairs

Usage

neuro config get-clusters [OPTIONS]

List available clusters/org pairs.

This command re-fetches cluster list and then displays each cluster with available orgs.

Options

Name	Description
--help	Show this message and exit.

login

Log into Neuro Platform

Usage

neuro config login [OPTIONS] [URL]

Log into Neuro Platform.

URL is a platform entrypoint URL.

Options

Name	Description
--help	Show this message and exit.

login-headless

Log into Neuro Platform in non-GUI environ

Usage

neuro config login-headless [OPTIONS] [URL]

Log into Neuro Platform in non-GUI environ

URL is a platform entrypoint URL.

The command works similar to "neuro login" but instead of opening a browser for performing OAuth registration prints an URL that should be open on guest host.

Then user inputs a code displayed in a browser after successful login back in neuro command to finish the login process.

Options

Name	Description
--help	Show this message and exit.

login-with-token

Log into Neuro Platform with token

Usage

neuro config login-with-token [OPTIONS] TOKEN [URL]

Log into Neuro Platform with token.

TOKEN is authentication token provided by administration team. URL is a platform entrypoint URL.

Options

Name	Description
--help	Show this message and exit.

logout

Log out

Usage

neuro config logout [OPTIONS]

Log out.

Options

Name	Description
--help	Show this message and exit.

show

Print current settings

Usage

neuro config show [OPTIONS]

Print current settings.

Options

Name	Description
--help	Show this message and exit.
--energy	Including cluster energy consumption and CO2 emissions information

show-token

Print current authorization token

Usage

neuro config show-token [OPTIONS]

Print current authorization token.

Options

Name	Description
--help	Show this message and exit.

switch-cluster

Switch the active cluster

Usage

neuro config switch-cluster [OPTIONS] [CLUSTER_NAME]

Switch the active cluster.

CLUSTER_NAME is the cluster name to select. The interactive prompt is used if the name is omitted (default).

Options

Name	Description
--help	Show this message and exit.

switch-org

Switch the active organization

Usage

neuro config switch-org [OPTIONS] ORG_NAME

Switch the active organization.

ORGNAME is the organization name to select. Use literal "NOORG" to switch to using current cluster directly instead of on behalf of some org.

Options

Name	Description
--help	Show this message and exit.

switch-project

Switch the active project

Usage

neuro config switch-project [OPTIONS] [PROJECT_NAME]

Switch the active project.

PROJECT_NAME is the project name to select. The interactive prompt is used if the name is omitted (default).

Options

Name	Description
--help	Show this message and exit.