Skip to content

Commit

Permalink
Merge pull request #223 from kinode-dao/kit-shorthands
Browse files Browse the repository at this point in the history
add shorthand to all kit commands
  • Loading branch information
jurij-jukic authored Jun 20, 2024
2 parents 42380c5 + c119a36 commit 9d9b0ff
Show file tree
Hide file tree
Showing 12 changed files with 24 additions and 0 deletions.
2 changes: 2 additions & 0 deletions src/kit/boot-fake-node.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# `kit boot-fake-node`

short: `kit f`

`kit boot-fake-node` starts a "fake" node connected to a "fake" chain (i.e. not connected to the live network), e.g.,

```
Expand Down
2 changes: 2 additions & 0 deletions src/kit/boot-real-node.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# `kit boot-real-node`

short: `kit e`

`kit boot-real-node` starts a Kinode connected to the live network, e.g.,

```
Expand Down
2 changes: 2 additions & 0 deletions src/kit/build-start-package.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# `kit build-start-package`

short: `kit bs`

`kit build-start-package` builds, installs and starts the indicated package directory, or the current working directory if none supplied, e.g.,

```
Expand Down
2 changes: 2 additions & 0 deletions src/kit/build.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# `kit build`

short: `kit b`

`kit build` builds the indicated package directory, or the current working directory if none supplied, e.g.,

```
Expand Down
2 changes: 2 additions & 0 deletions src/kit/chain.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# kit chain

short: `kit c`

`kit chain` starts a local fakechain with foundry's [anvil](https://github.com/foundry-rs/foundry/tree/master/crates/anvil), e.g.,

```
Expand Down
2 changes: 2 additions & 0 deletions src/kit/dev-ui.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# `kit dev-ui`

short: `kit d`

`kit dev-ui` starts a web development server with hot reloading for the indicated UI-enabled package (or the current working directory), e.g.,

```
Expand Down
2 changes: 2 additions & 0 deletions src/kit/inject-message.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# `kit inject-message`

short: `kit i`

`kit inject-message` injects the given message to the node running at given port/URL, e.g.,

```bash
Expand Down
2 changes: 2 additions & 0 deletions src/kit/new.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# `kit new`

short: `kit n`

`kit new` creates a Kinode package template at the specified path, e.g.,

```
Expand Down
2 changes: 2 additions & 0 deletions src/kit/remove-package.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# `kit remove-package`

short: `kit r`

`kit remove-package` removes an installed package from the given node (defaults to `localhost:8080`).

For example,
Expand Down
2 changes: 2 additions & 0 deletions src/kit/run-tests.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# `kit run-tests`

short: `kit t`

`kit run-tests` runs the tests specified by the given `.toml` file, or `tests.toml`, e.g.,

```
Expand Down
2 changes: 2 additions & 0 deletions src/kit/start-package.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# `kit start-package`

short: `kit s`

`kit start-package` installs and starts the indicated package directory (or current working directory) on the given Kinode (at `localhost:8080` by default), e.g.,

```
Expand Down
2 changes: 2 additions & 0 deletions src/kit/view-api.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# `kit view-api`

short: `kit v`

`kit view-api` fetches the list of APIs or a specific API for the given package.
`view-api` relies on a node to do so, e.g.

Expand Down

0 comments on commit 9d9b0ff

Please sign in to comment.