cmd

README

Nunet Command-Line Interface (CLI)

The Nunet Command-Line Interface (CLI) serves as a powerful tool for interacting with the Nunet ecosystem, enabling you to manage network configurations, control capabilities, and handle cryptographic keys. It provides a comprehensive set of commands to streamline various tasks and operations within the Nunet network.

Top-Level Commands

Actor System

nunet actor

This command provides a suite of operations tailored for interacting with the Nunet Actor System. It enables you to communicate with actors within the network, facilitating actions like sending messages, invoking specific behaviors, and broadcasting information to multiple actors simultaneously.

Detailed documentation can be found here.

Capability Management

nunet cap

This command focuses on capability management within the Nunet ecosystem. It allows you to define, delegate, and control the permissions and authorizations granted to different entities, ensuring secure and controlled interactions within the network.

Detailed documentation can be found here.

Configuration Management

nunet config

The config command allows to interact with and manage your configuration file directly from the command line. This allows you to view existing settings, modify them as needed, and ensure Nunet DMS is tailored to your preferences.

Usage

nunet config COMMAND

Available Commands

• edit: Opens the configuration file in your default text editor for manual adjustments.
• get: Retrieve and display the current value associated with a specific configuration key.
• set: Modify the configuration file by assigning a new value to a specified key.

Flags

• -h, --help: Display help information for the config command and its subcommands.

Key Management

nunet key

The Nunet Key Management CLI allows generating new keypairs and retrieve the Decentralized Identifier (DID) associated with a specific key.

Main Command

• nunet key

  • Description: The primary command to manage keys within the Nunet DMS

  • Usage: nunet key COMMAND

  • Available Commands:

    • did: Retrieve the DID for a specified key

    • new: Generate a new keypair

  • Flags:

    • -h, --help: Display help information for the main key command.

Subcommands

• nunet key did

  • Description: Retrieves and displays the DID associated with a specified key. This DID uniquely identifies the key within the Nunet network.

  • Usage: nunet key did <key-name> [flags]

  • Arguments:

    • <key-name>: The name of the key for which the DID is to be retrieved

  • Flags:

    • -h, --help: Display help information for the did command

• nunet key new

  • Description: Generates a new keypair and securely stores the private key in the user's local keystore. The corresponding public key can be used for various cryptographic operations within the Nunet DMS

  • Usage: nunet key new <name> [flags]

  • Arguments:

    • <name>: A name to identify the newly generated keypair

  • Flags:

    • -h, --help: Display help information for the new command.

Important Considerations:

• Keep your private keys secure, as they provide access to your identity and associated capabilities within the Nunet DMS

• Choose descriptive names for your keypairs to easily identify their purpose or associated devices.

Run Command

nunet run

Starts the Nunet Device Management Service (DMS) process, responsible for handling network operations and device management.

Usage:

nunet run [flags]

Flags:

• -c, --context string: Specifies the key and capability context to use (default: "dms").
• -h, --help: Displays help information for the run command.

Example:

nunet run

This starts the Nunet DMS with the default "dms" context.

GPU Command

nunet gpu

Purpose: The nunet gpu command provides gpu related apis.

Usage:

nunet gpu <operation>

Available Operations:

• list: List all the available GPUs on the system.
• test: Test the GPU deployment on the system using docker.

Flags:

• -h, --help: Display help information for the gpu command and its subcommands.

Example:

nunet gpu list

This command will list all the available GPUs on the system.

nunet gpu test

This command will test the GPU deployment on the system using docker.

Documentation

Index

• Variables
• func Execute()
• func NewRootCMD(dmsCli *cli.DmsCLI) *cobra.Command
• type Allocation
• type DeploymentNetwork
• type HostKeyManager
  • func NewHostKeyManager(afs afero.Afero, knownHostsPath string) (*HostKeyManager, error)
  • func (h *HostKeyManager) HostKeyCallback(out io.Writer) ssh.HostKeyCallback
• type RunOptions
• type TranslateOptions
• type ValidateOpts

Variables

var (
	Version   string
	GoVersion string
	BuildDate string
	Commit    string
)

Version information set by the build system (see Makefile)

Functions

func Execute

func Execute()

func NewRootCMD

func NewRootCMD(dmsCli *cli.DmsCLI) *cobra.Command

NewRootCMD returns the cmds

Types

type Allocation

type Allocation struct {
	Alloc       string
	PortMapping map[int]int
	DNSName     string
	IP          string
	Status      string
}

type DeploymentNetwork

type DeploymentNetwork struct {
	ID          string
	Allocations []Allocation
}

type HostKeyManager

type HostKeyManager struct {
	// contains filtered or unexported fields
}

Hostkey manager

func NewHostKeyManager

func NewHostKeyManager(afs afero.Afero, knownHostsPath string) (*HostKeyManager, error)

func (*HostKeyManager) HostKeyCallback

func (h *HostKeyManager) HostKeyCallback(out io.Writer) ssh.HostKeyCallback

type RunOptions

type RunOptions struct {
	Context  string
	PrismURL string
}

type TranslateOptions

type TranslateOptions struct {
	InputFile  string
	FromFormat string
	OutputFile string
}

type ValidateOpts

type ValidateOpts struct {
	InputFile string
}