Skip to content

Commit

Permalink
update --help
Browse files Browse the repository at this point in the history
  • Loading branch information
DenisCarriere committed Nov 29, 2023
1 parent 62ca706 commit 08e7e46
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 8 deletions.
15 changes: 8 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -110,13 +110,14 @@ Usage: substreams-sink-websockets [options]
Substreams Sink Websockets

Options:
--public-key <string> (required) Ed25519 public key (env: PUBLIC_KEY)
--port <int> Server listen on HTTP port (default: 3000, env: PORT)
--hostname <string> Server listen on HTTP hostname (default: "0.0.0.0", env: HOSTNAME)
--sqlite-filename <string> SQLite database filename (default: "db.sqlite", env: SQLITE_FILENAME)
--verbose <boolean> Enable verbose logging (default: false, env: VERBOSE)
-V, --version output the version number
-h, --help display help for command
--public-key <string> (required) Ed25519 public key (comma-separated for multiple public keys) (env: PUBLIC_KEY)
--port <int> Server listen on HTTP port (default: 3000, env: PORT)
--hostname <string> Server listen on HTTP hostname (default: "0.0.0.0", env: HOSTNAME)
--sqlite-filename <string> SQLite database filename (default: "db.sqlite", env: SQLITE_FILENAME)
--verbose <boolean> Enable verbose logging (default: false, env: VERBOSE)
--recent-messages-limit <int> Limit recent messages (default: 50, env: RECENT_MESSAGES_LIMIT)
-V, --version output the version number
-h, --help display help for command
```

## Docker environment
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
"homepage": "https://github.com/pinax-network/substreams-sink-websockets",
"type": "module",
"scripts": {
"start": "bun run index.ts",
"start": "bun run index.ts --help",
"test": "bun test",
"build": "bun build --compile ./index.ts --outfile substreams-sink-websockets",
"dev": "bun run --watch index.ts"
Expand Down

0 comments on commit 08e7e46

Please sign in to comment.