Node Overview


The bacalhau node command provides a set of sub-commands to query and manage node-related information within Bacalhau. With these tools, users can access specific details about nodes, list all network nodes, and more.


bacalhau node [command]

Available Commands

  1. approve:

    • Description: Approves a single node to join the cluster.

    • Usage:

      bacalhau node approve
  2. delete:

    • Description: Deletes a node from the cluster using its ID.

    • Usage:

      bacalhau node delete
  3. describe:

    • Description: Retrieves detailed information of a node using its ID.

    • Usage:

      bacalhau node describe
  4. list:

    • Description: Lists the details of all nodes present in the network.

    • Usage:

      bacalhau node list
  5. reject:

  • Description: Reject a specific node's request to join the cluster.

  • Usage:

    bacalhau node reject

For comprehensive details on any of the sub-commands, run:

bacalhau node [command] --help


  • -h, --help:

    • Description: Shows the help information for the node command.

Global Flags

  • --api-host string:

    • Description: Specifies the host for RESTful communication between the client and server. The flag will be ignored if the BACALHAU_API_HOST environment variable is set.

    • Default:

  • --api-port int:

    • Description: Designates the port for RESTful communication. The flag will be bypassed if the BACALHAU_API_PORT environment variable is active.

    • Default: 1234

  • --log-mode logging-mode:

    • Description: Chooses the preferred log format. Available choices are: default, station, json, combined, and event.

    • Default: default

  • --repo string:

    • Description: Specifies the path to the bacalhau repository.

    • Default: /Users/walid/.bacalhau

Last updated