Bacalhau Docs
GithubSlackBlogEnterprise
v1.6.x
  • Documentation
  • Use Cases
  • CLI & API
  • References
  • Community
v1.6.x
  • Welcome
  • Getting Started
    • How Bacalhau Works
    • Getting Started
      • Step 1: Install the Bacalhau CLI
      • Step 2: Running Your Own Job
      • Step 3: Checking on the Status of Your Job
    • Creating Your Own Bacalhau Network
      • Setting Up a Cluster on Amazon Web Services (AWS) with Terraform 🚀
      • Setting Up a Cluster on Google Cloud Platform (GCP) With Terraform 🚀
      • Setting Up a Cluster on Azure with Terraform 🚀
    • Hardware Setup
    • Container Onboarding
      • Docker Workloads
      • WebAssembly (Wasm) Workloads
  • Setting Up
    • Running Nodes
      • Node Onboarding
      • GPU Installation
      • Job selection policy
      • Access Management
      • Node persistence
      • Configuring Your Input Sources
      • Configuring Transport Level Security
      • Limits and Timeouts
      • Test Network Locally
      • Bacalhau WebUI
      • Private IPFS Network Setup
    • Workload Onboarding
      • Container
        • Docker Workload Onboarding
        • WebAssembly (Wasm) Workloads
        • Bacalhau Docker Image
        • How To Work With Custom Containers in Bacalhau
      • Python
        • Building and Running Custom Python Container
        • Running Pandas on Bacalhau
        • Running a Python Script
        • Running Jupyter Notebooks on Bacalhau
        • Scripting Bacalhau with Python
      • R (language)
        • Building and Running your Custom R Containers on Bacalhau
        • Running a Simple R Script on Bacalhau
      • Run CUDA programs on Bacalhau
      • Running a Prolog Script
      • Reading Data from Multiple S3 Buckets using Bacalhau
      • Running Rust programs as WebAssembly (WASM)
      • Generate Synthetic Data using Sparkov Data Generation technique
    • Networking Instructions
      • Accessing the Internet from Jobs
      • Utilizing NATS.io within Bacalhau
    • GPU Workloads Setup
    • Automatic Update Checking
    • Marketplace Deployments
      • Google Cloud Marketplace
    • Inter-Nodes TLS
  • Guides
    • Configuration Management
    • Write a config.yaml
    • Write a SpecConfig
    • Using Labels and Constraints
  • Examples
    • Table of Contents for Bacalhau Examples
    • Data Engineering
      • Using Bacalhau with DuckDB
      • Ethereum Blockchain Analysis with Ethereum-ETL and Bacalhau
      • Convert CSV To Parquet Or Avro
      • Simple Image Processing
      • Oceanography - Data Conversion
      • Video Processing
      • Bacalhau and BigQuery
    • Data Ingestion
      • Copy Data from URL to Public Storage
      • Pinning Data
      • Running a Job over S3 data
    • Model Inference
      • EasyOCR (Optical Character Recognition) on Bacalhau
      • Running Inference on Dolly 2.0 Model with Hugging Face
      • Speech Recognition using Whisper
      • Stable Diffusion on a GPU
      • Stable Diffusion on a CPU
      • Object Detection with YOLOv5 on Bacalhau
      • Generate Realistic Images using StyleGAN3 and Bacalhau
      • Stable Diffusion Checkpoint Inference
      • Running Inference on a Model stored on S3
    • Model Training
      • Training Pytorch Model with Bacalhau
      • Training Tensorflow Model
      • Stable Diffusion Dreambooth (Finetuning)
    • Molecular Dynamics
      • Running BIDS Apps on Bacalhau
      • Coresets On Bacalhau
      • Genomics Data Generation
      • Gromacs for Analysis
      • Molecular Simulation with OpenMM and Bacalhau
    • Systems Engineering
      • Ad-hoc log query using DuckDB
  • References
    • Jobs Guide
      • Job Specification
        • Job Types
        • Task Specification
          • Engines
            • Docker Engine Specification
            • WebAssembly (WASM) Engine Specification
          • Publishers
            • IPFS Publisher Specification
            • Local Publisher Specification
            • S3 Publisher Specification
          • Sources
            • IPFS Source Specification
            • Local Source Specification
            • S3 Source Specification
            • URL Source Specification
          • Network Specification
          • Input Source Specification
          • Resources Specification
          • ResultPath Specification
        • Constraint Specification
        • Labels Specification
        • Meta Specification
      • Job Templates
      • Queuing & Timeouts
        • Job Queuing
        • Timeouts Specification
      • Job Results
        • State
    • CLI Guide
      • Single CLI commands
        • Agent
          • Agent Overview
          • Agent Alive
          • Agent Node
          • Agent Version
        • Config
          • Config Overview
          • Config Auto-Resources
          • Config Default
          • Config List
          • Config Set
        • Job
          • Job Overview
          • Job Describe
          • Job Executions
          • Job History
          • Job List
          • Job Logs
          • Job Run
          • Job Stop
        • Node
          • Node Overview
          • Node Approve
          • Node Delete
          • Node List
          • Node Describe
          • Node Reject
      • Command Migration
    • API Guide
      • Bacalhau API overview
      • Best Practices
      • Agent Endpoint
      • Orchestrator Endpoint
      • Migration API
    • Node Management
    • Authentication & Authorization
    • Database Integration
    • Debugging
      • Debugging Failed Jobs
      • Debugging Locally
    • Running Locally In Devstack
    • Setting up Dev Environment
  • Help & FAQ
    • Bacalhau FAQs
    • Glossary
    • Release Notes
      • v1.5.0 Release Notes
      • v1.4.0 Release Notes
  • Integrations
    • Apache Airflow Provider for Bacalhau
    • Lilypad
    • Bacalhau Python SDK
    • Observability for WebAssembly Workloads
  • Community
    • Social Media
    • Style Guide
    • Ways to Contribute
Powered by GitBook
LogoLogo

Use Cases

  • Distributed ETL
  • Edge ML
  • Distributed Data Warehousing
  • Fleet Management

About Us

  • Who we are
  • What we value

News & Blog

  • Blog

Get Support

  • Request Enterprise Solutions

Expanso (2025). All Rights Reserved.

On this page
  • Description:
  • Usage:
  • Flags:
  • Global Flags:
  • Examples

Was this helpful?

Export as PDF
  1. References
  2. CLI Guide
  3. Single CLI commands
  4. Node

Node List

The bacalhau node list command is designed to provide users with a comprehensive list of network nodes along with details based on specified flags.

Description:

The list sub-command under the bacalhau node category enumerates information about nodes in the network. It supports various filtering, ordering, and output formatting options, allowing users to tailor the output to their needs.

Usage:

bacalhau node list [flags]

Flags:

  • -h, --help:

    • Show the help message for the list command.

  • --hide-header:

    • Do not display the column headers in the output.

  • --filter-approval:

    • Only show nodes with the specified approval status. Valid values are: approved, pending, rejected.

  • --filter-status:

    • Only show nodes with the specified state. Valid values are: healthy, unhealthy, unknown.

  • --labels string:

    • Filter nodes based on labels. This follows the filtering format provided by Kubernetes, as shown in their documentation about labels.

  • --limit uint32:

    • Restrict the number of results displayed.

  • --next-token string:

    • Provide the next token for pagination.

  • --no-style:

    • Output the table without any style.

  • --order-by string:

    • Sort the results based on a specific field. Valid sorting fields are: id, type, available_cpu, available_memory, available_disk, available_gpu.

  • --order-reversed:

    • Display the results in reverse order.

  • --output format:

    • Choose the output format. Available options: table, csv, json, yaml.

    • Default: table.

  • --pretty:

    • Enhance the visual appeal of the output. This is applicable only to json and yaml formats.

  • --show strings:

    • Determine the column groups to be displayed. Acceptable values are: labels, version, features, capacity.

    • Default: labels, capacity.

  • --wide:

    • Display full values in the output table, without truncation.

Global Flags:

  • --api-host string:

    • Specify the host for client-server communication via REST. This gets ignored if the BACALHAU_API_HOST environment variable is defined.

    • Default: "bootstrap.production.bacalhau.org".

  • --api-port int:

    • Specify the port for RESTful communication between client and server. Gets overlooked if the BACALHAU_API_PORT environment variable is set.

    • Default: 1234.

  • --log-mode logging-mode:

    • Choose the desired log format.

    • Options: 'default', 'station', 'json', 'combined', 'event'.

    • Default: 'default'.

  • --repo string:

    • Point to the directory path of the bacalhau repository.

    • Default: "$HOME/.bacalhau"`.

Examples

  1. Retrieve the list of nodes:

    Execute the command to get a list of all nodes:

    bacalhau node list

    Expected output:

     ID        TYPE     LABELS                                              CPU     MEMORY      DISK         GPU
     QmTSJgdN  Compute  Architecture=amd64 Operating-System=linux           3.2 /   11.7 GB /   77.8 GB /    1 /
                        git-lfs=True owner=bacalhau                         3.2     11.7 GB     77.8 GB      1
     QmVXwmdZ  Compute  Architecture=amd64 Operating-System=linux           3.2 /   12.5 GB /   77.8 GB /    0 /
                        git-lfs=True owner=bacalhau                         3.2     12.5 GB     77.8 GB      0
     QmXRdLru  Compute  Architecture=amd64 Operating-System=linux           3.2 /   12.5 GB /   78.0 GB /    0 /
                        git-lfs=True owner=bacalhau                         3.2     12.5 GB     78.0 GB      0
     ... [Additional nodes information] ...
  2. Filter the list of nodes by labels:

    Execute the command to get a list of nodes with specific labels:

    bacalhau node list --labels "Operating-System=linux,owner=bacalhau"

    Expected output:

    ID        TYPE     LABELS                                              CPU     MEMORY      DISK         GPU
    QmTSJgdN  Compute  Architecture=amd64 Operating-System=linux           3.2 /   11.7 GB /   77.8 GB /    1 /
                       git-lfs=True owner=bacalhau                         3.2     11.7 GB     77.8 GB      1
    ... [Additional nodes information] ...
  3. Order the list of nodes by available memory:

    Execute the command to get the list of nodes ordered by available memory:

    bacalhau node list --order-by available_memory

    Expected output:

    ID        TYPE     LABELS                                              CPU     MEMORY      DISK         GPU
    QmVXwmdZ  Compute  Architecture=amd64 Operating-System=linux           3.2 /   12.5 GB /   77.8 GB /    0 /
                       git-lfs=True owner=bacalhau                         3.2     12.5 GB     77.8 GB      0
    ... [Additional nodes information] ...
  4. Limit the number of nodes displayed and output in JSON format:

    Execute the command to get a limited list of nodes in JSON format:

    bacalhau node list  --limit 3 --output json --pretty

    Expected output:

    [
      {
        "PeerInfo": {
          "ID": "QmTSJgdN7zCPAqBCkmdsdpFbiJV8bJ6zhoxK9N5xfar1sz",
          ... [Additional node details] ...
        },
        ... [Other nodes] ...
      }
    ]
PreviousNode DeleteNextNode Describe

Was this helpful?