BTQ Node Command Line Interface
Here's the adapted guide for interacting with the BTQ network using the Command Line Interface (CLI)
BTQ Node Command Line Interface
Interacting with the BTQ network can be done utilizing the CLI interface. This allows you to complete advanced tasks on the network. Using the CLI is straightforward, and there is a helpful --help
section to guide you.
It is recommended that you have a local working installation of BTQ to use the CLI. Refer to the Node installation instructions to get started. Follow the guide to set up a BTQ node if you haven't already.
Remote Node Connection
You can connect to a remote node that allows external connections. Use the --host {REMOTE_IP_ADDRESS}
flag on the CLI to connect.
Overview
Running commands using the BTQ node CLI requires the BTQ node software to be installed. Refer to the documentation for installation instructions and the full Node CLI documentation.
CLI Help
All command line options have a help file available to assist in their usage. Simply add the --help
option to the end of any command to see the help.
Usage
Example: btq tx_transfer --help
Options
These options allow advanced functionality like remote node connections.
Note: These options must be entered directly after the btq
command, before any sub-commands are given.
--host
[default: 127.0.0.1] Host to connect to for network functions and chain data retrieval
--port_pub
[default: 19009] Port to use to connect to node services for network functions and chain data retrieval using the node public API
--wallet_dir
Full path to the location of the wallet.json
file to use for the function if not included in the local directory
--json
Print command output as JSON data for scripting functions
--version
Print the version of the BTQ software and exit
--help
Print the help file and exit
This guide should assist you in using the BTQ CLI for various tasks and advanced operations.
Last updated