Skip to content

Latest commit

 

History

History
77 lines (52 loc) · 2.25 KB

README.md

File metadata and controls

77 lines (52 loc) · 2.25 KB
Raw

Ocelloids Data Steward CLI

The Ocelloids Data Steward CLI fetches aggregated data in JSON format from the Ocelloids data steward agent and outputs it to stdout, allowing you to easily use it with other command-line tools like jq.

Ocelloids Data Steward Agent command-line interface

Usage:
  steward [command]

Available Commands:
  fetch       Prints assets or chains data to stdout
  help        Help about any command

Flags:
  -k, --api-key string    Ocelloids API key
      --config string     config file (default is $HOME/.stw.yaml)
  -c, --cursor string     Page cursor
  -h, --help              help for steward
  -u, --http-url string   HTTP API base URL (default "https://api.ocelloids.net")
  -l, --limit uint16      Max results per page (default 25)

Use "steward [command] --help" for more information about a command.

Install

To install the Ocelloids Data Steward CLI, download the appropriate binary for your platform from the GitHub Releases page.

Steps to Install

  1. Visit the releases page: Go to the Ocelloids Data Steward CLI Releases.

  2. Choose your platform: Select the binary that matches your operating system (e.g., Linux, macOS, Windows) and architecture (e.g., x86, x64, ARM).

  3. Download the binary package: Click on the appropriate binary to start the download.

  4. Extract the binary executable: Once downloaded, extract the go-steward binary from the package.

  5. Move the binary to a directory in your PATH: Move the binary to a directory included in your system's PATH environment variable for easy access:

    mv go-steward /usr/local/bin/steward

  6. Verify installation: Confirm the installation by running the following command:

    steward help

Usage

Download Assets Data

Fetch assets data and save it to a JSON Lines (JSONL) file:

steward fetch assets > assets.jsonl

To convert the JSONL file into a JSON array, use jq:

jq --slurp . < assets.jsonl > assets.json

Download Chains Data

Fetch chains data and save it to a JSONL file:

steward fetch chains > chains.jsonl

Have fun!