Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update cmd options in subql-node README #1265

Merged
merged 2 commits into from
Aug 25, 2022
Merged

Update cmd options in subql-node README #1265

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
082f7c7
Update README.md
mzxyz Aug 25, 2022
a6680ba
Update packages/node/README.md
mzxyz Aug 25, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 20 additions & 6 deletions packages/node/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,13 +17,21 @@ $> subql-node
Options:
--help Show help [boolean]
--version Show version number [boolean]
-f, --subquery Local path of the subquery project [string]
--subquery-name Name of the subquery project [string]
-f, --subquery Local path or IPFS cid of the subquery project
[string] [required] [default: process.cwd()]
--subquery-name Name of the subquery project [deprecated] [string]
-c, --config Specify configuration file [string]
--local Use local mode [boolean]
--local Use local mode [deprecated] [boolean]
--force-clean Force clean the database, dropping project schemas
and tables [boolean]
--db-schema Db schema name of the project [string]
--unsafe Allows usage of any built-in module within the
sandbox [boolean]
--subscription Enable subscription by create notification triggers
[boolean] [default: false]
--batch-size Batch size of blocks to fetch in one round [number]
--scale-batch-size scale batch size based on memory usage
[boolean] [default: false]
--timeout Timeout for indexer sandbox to execute the mapping
functions [number]
--debug Show debug information to console output. will
Expand All @@ -41,14 +49,20 @@ Options:
--migrate Migrate db schema (for management tables only)
[boolean] [default: false]
--timestamp-field Enable/disable created_at and updated_at in schema
[boolean] [default: true]
[boolean] [default: false]
-d, --network-dictionary Specify the dictionary api for this network [string]
--dictionary-timeout Max timeout for dictionary query [number]
-m, --mmr-path Local path of the merkle mountain range (.mmr) file
[string]
--proof-of-index Enable/disable proof of index
[boolean] [default: false]
-p, --port The port the service will bind to
[number] [default: 3000]
--ipfs IPFS gateway endpoint [string]
-p, --port The port the service will bind to [number]
--disable-historical Disable storing historical state entities
[boolean] [default: true]
--reindex Reindex to specified block height [number]
-w, --workers Number of worker threads to use for fetching and
processing blocks. Disabled by default. [number]
```

## License
Expand Down