cmd

Last updated: 2024-11-21 22:05:59.815188 File source: link on GitLab

Introduction

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.

TAP Command

nunet tap

Purpose: Creates a TAP (network tap) interface to bridge the host network with a virtual machine (VM). It also configures network settings like IP forwarding and iptables rules.

Key Points:

• Root Privileges Required: This command necessitates root or administrator privileges for execution due to its manipulation of network interfaces and system-level settings.

Usage:

nunet tap [main_interface] [vm_interface] [CIDR] [flags]

Arguments:

• main_interface: (e.g., eth0) The name of the existing network interface on your host machine that you want to bridge with the TAP interface.

• vm_interface: (e.g., tap0) The name you want to assign to the newly created TAP interface.

• CIDR: (e.g., 172.16.0.1/24) The Classless Inter-Domain Routing (CIDR) notation specifying the IP address range and subnet mask for the TAP interface. This ensures that the VM or container connected to the TAP has its own IP address within the specified network.

Flags:

• -h, --help: Displays help information for the tap command.

Example:

sudo nunet tap eth0 tap0 172.16.0.1/24

This command will create a TAP interface named 'tap0' bridged to your host's 'eth0' interface. The 'tap0' interface will be assigned an IP address of '172.16.0.1' with a subnet mask of '/24'. This configuration allows a VM connected to 'tap0' to access the network through your host's 'eth0' interface.

Important Notes:

• Ensure you have the necessary permissions to execute this command.

• Be cautious when configuring network settings, as incorrect configurations can disrupt your network connectivity.

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.