Staex logostaexDocs
Docs/MCC CLI Reference

MCC CLI Reference

Complete command-line reference for the mcc client tool.

Overview#

The mcc client tool communicates with the MCC daemon via a UNIX socket. The default socket path is /tmp/.mcc-socket. All node management, tunnel operations, and diagnostic queries are performed through this tool.

General Options#

  • -s /tmp/.mcc-socket or --unix -- specify the daemon socket path
  • --help -- display help information
  • --version -- print the MCC version

Node Commands#

  • mcc id -- display the current node's unique identifier
  • mcc parent -- show the parent node's socket address
  • mcc health -- perform a daemon health check (exit code 0 indicates success)

Address Resolution#

bash
mcc resolve [options] address

Resolves an address across different formats. Use the -t flag to specify the target format:

  • ipv4 -- resolve to an IPv4 address
  • ipv6 -- resolve to an IPv6 address
  • mac6 -- resolve to a MAC address
  • node-id -- resolve to a node ID

Routing#

bash
mcc route destination [source]

Queries the routing information for a given destination node. Optionally specify a source to inspect the route from a specific origin.

Initialization#

bash
mcc init [options] [network-certificate-base64]

Options:

  • --parents -- comma-separated list of parent node addresses
  • --stdin -- read the network private key from standard input
  • -y / --force -- overwrite existing configuration without prompting
  • -C / --config-dir -- set the configuration directory (default: /etc/mcc)

Tunnel Management#

bash
mcc create-tunnel [options]

Required options:

  • --targets -- protocol:port pairs defining the forwarded services (e.g. tcp:80, udp:53)
  • --remote-node -- the node ID of the tunnel peer
Additional options:
  • --dns-names -- assign DNS names to the tunnel endpoint
  • --static-ip-address -- assign a fixed overlay IP
  • --external-ip-address -- proxy an external IP device (RFC 1918 addresses only)
  • Output directory for generated configuration files

Network Information#

  • mcc nodes [-f table|graphviz] -- list all known nodes in the network. Use -f graphviz to output the topology in Graphviz DOT format for visualization.
  • mcc certificates [config-file] -- display the node and network certificates from the specified configuration (or the default).