Skip to content

Commit

Permalink
kit: update
Browse files Browse the repository at this point in the history
  • Loading branch information
nick1udwig committed May 25, 2024
1 parent 79897dd commit 2fc4688
Show file tree
Hide file tree
Showing 5 changed files with 31 additions and 9 deletions.
1 change: 1 addition & 0 deletions src/kit-dev-toolkit.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@
* [`kit start-package`](./kit/start-package.md)
* [`kit build-start-package`](./kit/build-start-package.md)
* [`kit remove-package`](./kit/remove-package.md)
* [`kit chain`](./kit/chain.md)
* [`kit dev-ui`](./kit/dev-ui.md)
* [`kit inject-message`](./kit/inject-message.md)
* [`kit run-tests`](./kit/run-tests.md)
Expand Down
10 changes: 5 additions & 5 deletions src/kit/boot-fake-node.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,13 +56,13 @@ Options:
-r, --runtime-path <PATH>
Path to Kinode core repo or runtime binary (overrides --version)
-v, --version <VERSION>
Version of Kinode binary to use (overridden by --runtime-path) [default: latest] [possible values: latest, v0.5.3-alpha, v0.5.2-alpha, v0.5.1-alpha]
Version of Kinode binary to use (overridden by --runtime-path) [default: latest] [possible values: latest, v0.7.4, v0.7.3, v0.7.2]
-p, --port <NODE_PORT>
The port to run the fake node on [default: 8080]
-h, --home <HOME>
-o, --home <HOME>
Where to place the home directory for the fake node [default: /tmp/kinode-fake-node]
-f, --fake-node-name <NODE_NAME>
Name for fake node [default: fake.os]
Name for fake node [default: fake.dev]
-c, --fakechain-port <FAKECHAIN_PORT>
The port to run the fakechain on (or to connect to) [default: 8545]
--rpc <RPC_ENDPOINT>
Expand All @@ -75,7 +75,7 @@ Options:
If set and given --runtime-path, compile release build [default: debug build]
--verbosity <VERBOSITY>
Verbosity of node: higher is more verbose [default: 0]
--help
-h, --help
Print help
```

Expand Down Expand Up @@ -108,7 +108,7 @@ Run the fake node on this port; defaults to `8080`.

### `--home`

short: `-h`
short: `-o`

Path to place fake node home directory at; defaults to `/tmp/kinode-fake-node`.

Expand Down
11 changes: 9 additions & 2 deletions src/kit/build-start-package.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,8 @@ Options:
--ui-only If set, build ONLY the web UI for the process
-s, --skip-deps-check If set, do not check for dependencies
--features <FEATURES> Pass these comma-delimited feature flags to Rust cargo builds
-h, --help Print help```
-v, --verbose If set, output stdout and stderr
-h, --help Print help
```

### Optional positional arg: `DIR`
Expand Down Expand Up @@ -77,4 +78,10 @@ Don't check for dependencies.
Build the package with the given [cargo features](https://doc.rust-lang.org/cargo/reference/features.html).

Features can be used like shown [here](https://doc.rust-lang.org/cargo/reference/features.html#command-line-feature-options).
Currently the only feature supported system-wide is `simulation-mode`.
Currently the only feature supported system-wide is `simulation-mode`.

### `--verbose`

short: `-v`

Always output stdout and stderr if set.
11 changes: 9 additions & 2 deletions src/kit/build.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,9 +69,10 @@ Arguments:
Options:
--no-ui If set, do NOT build the web UI for the process; no-op if passed with UI_ONLY
--ui-only If set, build ONLY the web UI for the process
--ui-only If set, build ONLY the web UI for the process; no-op if passed with NO_UI
-s, --skip-deps-check If set, do not check for dependencies
--features <FEATURES> Pass these comma-delimited feature flags to Rust cargo builds
-v, --verbose If set, output stdout and stderr
-h, --help Print help
```

Expand Down Expand Up @@ -100,4 +101,10 @@ Don't check for dependencies.
Build the package with the given [cargo features](https://doc.rust-lang.org/cargo/reference/features.html).

Features can be used like shown [here](https://doc.rust-lang.org/cargo/reference/features.html#command-line-feature-options).
Currently the only feature supported system-wide is `simulation-mode`.
Currently the only feature supported system-wide is `simulation-mode`.

### `--verbose`

short: `-v`

Always output stdout and stderr if set.
7 changes: 7 additions & 0 deletions src/kit/chain.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,10 +27,17 @@ Usage: kit chain [OPTIONS]
Options:
-p, --port <PORT> Port to run the chain on [default: 8545]
-v, --verbose If set, output stdout and stderr
-h, --help Print help
```

### `--port`

Port to run anvil fakechain on.
Defaults to `8545`.

### `--verbose`

short: `-v`

Always output stdout and stderr if set.

0 comments on commit 2fc4688

Please sign in to comment.