Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
mfornos committed Aug 5, 2024
1 parent 6a59ef0 commit ca0a876
Showing 1 changed file with 28 additions and 1 deletion.
29 changes: 28 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,31 @@
TODO documentation :)
# 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`.

```shell
Ocelloids Data Steward Agent command line interface

Usage:
steward [command]

Available Commands:
fetch Streams either 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)
-h, --help help for steward
-u, --http-url string HTTP API base URL (default "https://dev-api.ocelloids.net")

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

---

NOTES

to clean up :)

```
jq --slurp . < assets.jsonl > assets.json
Expand Down

0 comments on commit ca0a876

Please sign in to comment.