Introduction

The Node Command Line Interface (CLI) provides a set of commands that allow users to configure, monitor, and manage LFG Node CLI and Project Workloads. This guide provides an overview of the key commands available within the LFG Node CLI, ensuring users can efficiently manage, maintain, and update their workloads.

Prior Knowledge

Before using the LFG Node CLI commands, users should be familiar with the following articles:

• Install LFG Node CLI on Ubuntu Linux: This guide provides step-by-step instructions for installing the LFG Node CLI on an Ubuntu Linux system.

• LFG Node CLI Hardware Requirements: This article outlines the hardware specifications needed to effectively run the LFG Node CLI.

• LFG Node Dashboard: A guide that walks users through the features of the LFG Node Dashboard.

• LFG Node FAQs: A collection of frequently asked questions about the LFG Node system, addressing common issues and providing helpful tips for using the CLI and related tools.

Node CLI Commands

The LFG Node CLI offers a variety of commands, from managing configuration to performing node management tasks. Below is a breakdown of each available command, along with its function:

lfgnode help

Examples:

Displays all available commands:

lfgnode help

Displays commands related to the configuration:

lfgnode config -h

Displays commands related to workloads:

lfgnode workload -h

lfgnode config

Configure your Node to retrieve the necessary information for connecting it to the Node Dashboard.

Available Commands:

• private-key: Manage private keys.
  • generate: Generate a new private key.
  • set: Set a private key

Example: 

Generate a Private Key:

lfgnode config private-key generate

Assign a Private Key to your Node:

lfgnode config private-key set [Private Key]

lfgnode down

Removes the assigned workload(s) and Node Docker instance from your machine.

lfgnode down

lfgnode info

Displays the current details and status of your node.

lfgnode info

lfgnode licenses

Displays your licenses.

lfgnode licenses

lfgnode start

Starts an LFG Node after it has been configured or rebooted.

lfgnode start

lfgnode status

Checks if the node is active or experiencing issues.

lfgnode status

lfgnode stop

Stops an active LFG Node.

lfgnode stop

lfnode version

Displays the currently installed version of the LFG Node.

lfnode version

lfgnode workload

Manages workloads on the node, including starting, listing, removing, and checking the status of workloads.

Available Commands:

• add: Add a workload to the Node.
• list: List all workloads.
• logs: Get workload logs.
• remove: Remove a workload.
• restart: Restart a workload.
• status: Get the status of a workload.

Examples: 

Add a Project workload:

lfgnode workload add [workload_name] 

To list all active workloads:

lfgnode workload list

Retrieves logs for a specific workload:

lfgnode workload logs [workload_name] 

Removes a specific workload from the node:

lfgnode workload remove [workload_name] 

Restarts a specific workload:

lfgnode workload restart [workload_name] 

Displays the current status of a specific workload:

lfgnode workload status [workload_name] 

Conclusion

The LFG Node CLI commands provide helpful tools for managing your workloads, whether you're setting up a new node, checking system details, or managing a workload. By becoming familiar with these commands, you can effectively manage your LFG Nodes.