diff --git a/src/SUMMARY.md b/src/SUMMARY.md index d00353ca..a9ee26d1 100644 --- a/src/SUMMARY.md +++ b/src/SUMMARY.md @@ -20,7 +20,7 @@ - [Terminal](./terminal.md) - [Process Standard Library](./process_stdlib/overview.md) - [Kit: Development Tool**kit**](./kit-dev-toolkit.md) - - [Install](./kit/install.md) + - [Installation](./kit/install.md) - [`boot-fake-node`](./kit/boot-fake-node.md) - [`new`](./kit/new.md) - [`build`](./kit/build.md) @@ -29,6 +29,7 @@ - [`dev-ui`](./kit/dev-ui.md) - [`inject-message`](./kit/inject-message.md) - [`run-tests`](./kit/run-tests.md) + - [`reset-cache`](./kit/reset-cache.md) - [Tutorial: Build and Deploy an App](./build-and-deploy-an-app.md) - [Environment Setup](./my_first_app/chapter_1.md) - [Sending Some Messages, Using Some Tools](./my_first_app/chapter_2.md) diff --git a/src/kit-dev-toolkit.md b/src/kit-dev-toolkit.md index e0d40371..7d4c6158 100644 --- a/src/kit-dev-toolkit.md +++ b/src/kit-dev-toolkit.md @@ -1,14 +1,15 @@ # kit -`kit` is a tool**kit** that make development on Kinode OS ergonomic. +`kit` is a tool**kit** to make development on Kinode OS ergonomic. ## Table of Contents -* [Install](./install.md) -* [`kit boot-fake-node`](./boot-fake-node.md) -* [`kit new`](./new.md) -* [`kit build`](./build.md) -* [`kit start-package`](./start-package.md) -* [`kit dev-ui`](./dev-ui.md) -* [`kit inject-message`](./inject-message.md) -* [`kit run-tests`](./run-tests.md) +* [Installation](./kit/install.md) +* [`kit boot-fake-node`](./kit/boot-fake-node.md) +* [`kit new`](./kit/new.md) +* [`kit build`](./kit/build.md) +* [`kit start-package`](./kit/start-package.md) +* [`kit remove-package`](./kit/start-package.md) +* [`kit dev-ui`](./kit/dev-ui.md) +* [`kit inject-message`](./kit/inject-message.md) +* [`kit reset-cache`](./kit/reset-cache.md) diff --git a/src/kit/boot-fake-node.md b/src/kit/boot-fake-node.md index 88859a8c..bb0021cf 100644 --- a/src/kit/boot-fake-node.md +++ b/src/kit/boot-fake-node.md @@ -2,7 +2,7 @@ `kit boot-fake-node` starts a "fake" (i.e. not connected to the live network) node, e.g., -```bash +``` kit boot-fake-node ``` @@ -15,7 +15,7 @@ You can start a network of fake nodes that can communicate with each other (but You'll need to start a new terminal for each fake node. For example, to start two fake nodes, `fake.os` and `fake2.os`: -```bash +``` kit boot-fake-node # In a new terminal @@ -81,7 +81,7 @@ Options: Pass to run a local binary or build a local Kinode core repo and use the resulting binary, e.g. -```bash +``` kit boot-fake-node --runtime-path ~/git/kinode ``` diff --git a/src/kit/build.md b/src/kit/build.md index 0c7cd378..d8492aa6 100644 --- a/src/kit/build.md +++ b/src/kit/build.md @@ -2,13 +2,13 @@ `kit build` builds the indicated package directory, or the current working directory if none supplied, e.g., -```bash +``` kit build foo ``` or -```bash +``` kit build ``` diff --git a/src/kit/dev-ui.md b/src/kit/dev-ui.md index eb56b4b7..3a7784f5 100644 --- a/src/kit/dev-ui.md +++ b/src/kit/dev-ui.md @@ -2,13 +2,13 @@ `kit dev-ui` starts a web development server with hot reloading for the indicated UI-enabled package (or the current working directory), e.g., -```bash +``` kit dev-ui foo ``` or -```bash +``` kit dev-ui ``` diff --git a/src/kit/inject-message.md b/src/kit/inject-message.md index 64e54d10..3faf6d50 100644 --- a/src/kit/inject-message.md +++ b/src/kit/inject-message.md @@ -2,7 +2,7 @@ `kit inject-message` injects the given message to the node running at given port/URL, e.g., -```bash +``` kit inject-message foo:foo:template.os '{"Send": {"target": "fake2.os", "message": "hello world"}}' ``` diff --git a/src/kit/install.md b/src/kit/install.md index 73eff30b..c71ea4f3 100644 --- a/src/kit/install.md +++ b/src/kit/install.md @@ -6,7 +6,7 @@ You are encouraged to make use of the `--help` flag, which can be used for the t ``` $ kit --help -Development toolkit for Kinode OS +Development toolkit for Kinode Usage: kit @@ -14,11 +14,12 @@ Commands: boot-fake-node Boot a fake node for development [aliases: f] build Build a Kinode package [aliases: b] build-start-package Build and start a Kinode package [aliases: bs] - dev-ui Start the web UI development server with hot reloading (same as `cd ui && npm i && npm start`) [aliases: d] + dev-ui Start the web UI development server with hot reloading (same as `cd ui && npm i && npm run dev` [aliases: d] inject-message Inject a message to a running Kinode [aliases: i] new Create a Kinode template package [aliases: n] - run-tests Run Kinode tests [aliases: t] remove-package Remove a running package from a node [aliases: r] + reset-cache Reset kit cache (Kinode core binaries, logs, etc.) + run-tests Run Kinode tests [aliases: t] setup Fetch & setup kit dependencies start-package Start a built Kinode process [aliases: s] update Fetch the most recent version of kit @@ -41,13 +42,13 @@ The first chapter of the [Build and Deploy an App tutorial](../my_first_app/chap To get `kit`, run -```bash +``` cargo install --git https://github.com/kinode-dao/kit ``` To update, run that same command or -```bash +``` kit update ``` diff --git a/src/kit/new.md b/src/kit/new.md index 923c8f5a..5c98476d 100644 --- a/src/kit/new.md +++ b/src/kit/new.md @@ -2,7 +2,7 @@ `kit new` creates a Kinode package template at the specified path, e.g., -```bash +``` kit new foo ``` @@ -10,7 +10,7 @@ creates the default template (a Rust chat app with no UI) in the `foo/` director ## Example Usage -```bash +``` # Create the default template: rust chat with no UI kit new my_rust_chat diff --git a/src/kit/remove-package.md b/src/kit/remove-package.md index b7613394..14eb4a45 100644 --- a/src/kit/remove-package.md +++ b/src/kit/remove-package.md @@ -6,13 +6,13 @@ If no arguments are provided, the same process happens for the current working d Alternatively, a `--package` and `--publisher` can be provided as arguments, and that package will be removed. For example, -```bash +``` kit remove-package foo ``` or -```bash +``` kit remove-package -package foo --publisher template.os ``` diff --git a/src/kit/reset-cache.md b/src/kit/reset-cache.md new file mode 100644 index 00000000..455a8c97 --- /dev/null +++ b/src/kit/reset-cache.md @@ -0,0 +1,21 @@ +# `kit reset-cache` + +`kit reset-cache` resets the cache `kit` writes Kinode core binaries, logs, etc. to. + +## Discussion + +In general, `kit reset-cache` should not need to be used. +There are occasionally cases where the `kit` cache gets corrupted. +If seeing confusing and difficult to explain behavior from `kit`, a `kit reset-cache` won't hurt. + +## Arguments + +``` +$ kit reset-cache --help +Reset kit cache (Kinode core binaries, logs, etc.) + +Usage: kit reset-cache + +Options: + -h, --help Print help +``` diff --git a/src/kit/run-tests.md b/src/kit/run-tests.md index 977992f7..fa80d6c4 100644 --- a/src/kit/run-tests.md +++ b/src/kit/run-tests.md @@ -2,13 +2,13 @@ `kit run-tests` runs the tests specified by the given `.toml` file, or `tests.toml`, e.g., -```bash +``` kit run-tests my_tests.toml ``` or -```bash +``` kit run-tests ``` @@ -29,7 +29,7 @@ If a given test `Pass`es, the next test in the series is run. ## Arguments -```bash +``` $ kit t --help Run Kinode tests diff --git a/src/kit/start-package.md b/src/kit/start-package.md index 279f2a59..42f0f756 100644 --- a/src/kit/start-package.md +++ b/src/kit/start-package.md @@ -2,13 +2,13 @@ `kit start-package` installs and starts the indicated package directory (or current working directory) on the given Kinode, e.g., -```bash +``` kit start-package foo ``` or -```bash +``` kit start-package ```