🤖CLI commands

1. Monitor Storage Usage

Use the following command to check the amount of storage space used by Titan, the maximum storage limit as set by the user, and the available storage space remaining.

titan-edge info

2. Node Operations: Start or Stop

Use the following commands to start and stop your node.

Start command:

titan-edge daemon start

Stop command:

titan-edge daemon stop

3. Check Node ID

Use the following command to check each node’s unique ID:

titan-edge info

4. Changing the Storage Path

titan-edge config set --storage-path /new/path/to/storage

Function Description

This command lets users change the node's data storage location.

Parameters

  • Replace /new/path/to/storage with your desired storage path.

Important Notes & Precautions

Post-Command Execution: Post-Command Execution: Existing files will automatically move to the new specified directory. However, please note that the original files will remain in the old directory and must be manually deleted.

Node Restart Requirement: For the changes to take effect, you'll need to manually restart the node. Follow the second step in the documentation to safely stop and then restart node operations.

Handling Active Downloads: If there are any downloads in progress when you update the storage path, they may be interrupted and could fail. Please ensure that there are no ongoing active downloads before and while you change the storage path.

5. Adjusting Storage Capacity

To set the maximum storage space for a Titan node, use the following command:

titan-edge config set --storage-size 50GB

Function Description

This command adjusts the maximum storage capacity for a Titan node.

Parameters

  • 50GB can be changed to any desired limit, such as 100GB or 500GB.

Important Notes & Precautions:

  • Post-Command Execution: A manual restart of the node is necessary to activate the changes to the storage space.

  • Node Restart Requirement: To restart a node, first stop the node and then start it again. This ensures that any updates are correctly applied. See the second step in the guide for detailed instructions.

6. Viewing Configuration Settings

The following command allows users to check configuration settings of a node, especially for verifying the proper application of configuration modifications.

Use the following command to review your node's settings and confirm that changes to the configuration have been applied correctly:

titan-edge config show

Note: Please note that a node restart is required for any changes or updates to your node’s configuration or values to take effect. Make sure to restart your node following any modifications to its configuration.

7. View Device Binding Information

Users can use the following command to view the device binding information for their Titan node:

titan-edge show binding-info https://web-server-api-url

Note: Make sure to replacehttps://web-server-api-url with the actual Web server API URL used by the current network, which is:

https://api-test1.container1.titannet.io/api/v2/device

In the future, the Web server API URL used by the network may be updated periodically.

8. Check the Active Downloads

Use the following to see if your Titan Node has an ongoing download tasks:

titan-edge cache

Function Description

This command provides information about the cache status of a Titan node, including the number of assets waiting to be cached. This information helps you understand whether the node is currently processing download tasks.

*if the wait cache asset count is not 0, this indicates that the node does have active download tasks.

9. Run the Node in Background

Use the following command to run nodes in background:

nohup ./titan-edge daemon start --init --url https://test-locator.titannet.io:5000/rpc/v0  > edge.log 2>&1 &

Last updated