From 2d33c114d7404f042816fe744067970b3de3e2a2 Mon Sep 17 00:00:00 2001 From: jurij-jukic Date: Fri, 10 May 2024 11:44:18 +0200 Subject: [PATCH 1/7] wip --- src/SUMMARY.md | 1 + src/kit/build-start-package.md | 69 ++++++++++++++++++++++++++++++++++ 2 files changed, 70 insertions(+) create mode 100644 src/kit/build-start-package.md diff --git a/src/SUMMARY.md b/src/SUMMARY.md index 0620cfef..78932401 100644 --- a/src/SUMMARY.md +++ b/src/SUMMARY.md @@ -25,6 +25,7 @@ - [`new`](./kit/new.md) - [`build`](./kit/build.md) - [`start-package`](./kit/start-package.md) + - [`build-start-package`](./kit/build-start-package.md) - [`remove-package`](./kit/remove-package.md) - [`dev-ui`](./kit/dev-ui.md) - [`inject-message`](./kit/inject-message.md) diff --git a/src/kit/build-start-package.md b/src/kit/build-start-package.md new file mode 100644 index 00000000..86d8af59 --- /dev/null +++ b/src/kit/build-start-package.md @@ -0,0 +1,69 @@ +# `kit build-start-package` + +`kit build-start-package` builds, installs and starts the indicated package directory, or the current working directory if none supplied + + e.g., + +``` +kit build-start-package foo +``` + +or + +``` +kit build-start-package +``` + +## Discussion + +`kit build-start-package` runs `kit build` followed by `kit start-package`. + +## Arguments + +``` +$ kit build-start-package --help +Build and start a Kinode package + +Usage: kit build-start-package [OPTIONS] [DIR] + +Arguments: + [DIR] The package directory to build [default: /home/nick/git/kit] + +Options: + -p, --port Node port: for use on localhost (overridden by URL) [default: 8080] + -u, --url Node URL (overrides NODE_PORT) + --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 + -s, --skip-deps-check If set, do not check for dependencies + --features Pass these comma-delimited feature flags to Rust cargo builds + -h, --help Print help``` +``` + +### Optional positional arg: `DIR` + +The package directory to build, install and start on the node; defaults to the current working directory. + +### `--port` + +For nodes running on localhost, the port of the node; defaults to `8080`. +`--port` is overridden by `--url` if both are supplied. + +### `--url` + +The URL the node is hosted at. +Can be either localhost or remote. +`--url` overrides `--port` if both are supplied. + + +### `--ui-only` + +Build ONLY the UI for a package with a UI. +Otherwise, for a package with a UI, both the package and the UI will be built. + +### `--quiet` + +Don't print the build stdout/stderr. + +### `--skip-deps-check` + +Don't check for dependencies. From 9a5cccfb1a76a3af5bbeac6ab6b5f8e49470463f Mon Sep 17 00:00:00 2001 From: jurij-jukic Date: Fri, 10 May 2024 11:57:01 +0200 Subject: [PATCH 2/7] build-start-package page --- src/kit/build-start-package.md | 16 ++++++++++++---- 1 file changed, 12 insertions(+), 4 deletions(-) diff --git a/src/kit/build-start-package.md b/src/kit/build-start-package.md index 86d8af59..b9b51847 100644 --- a/src/kit/build-start-package.md +++ b/src/kit/build-start-package.md @@ -45,25 +45,33 @@ The package directory to build, install and start on the node; defaults to the c ### `--port` +short: `-p` + For nodes running on localhost, the port of the node; defaults to `8080`. `--port` is overridden by `--url` if both are supplied. ### `--url` +short: `-u` + The URL the node is hosted at. Can be either localhost or remote. `--url` overrides `--port` if both are supplied. +### `--no-ui` + +Do not build the web UI for the process. +Does nothing if passed with `--ui-only`. ### `--ui-only` Build ONLY the UI for a package with a UI. Otherwise, for a package with a UI, both the package and the UI will be built. -### `--quiet` - -Don't print the build stdout/stderr. - ### `--skip-deps-check` +short: `-s` + Don't check for dependencies. + +### `--features` From 266bd9cbf57f1f9ccfeb9879f307590b569d0e2e Mon Sep 17 00:00:00 2001 From: jurij-jukic Date: Fri, 10 May 2024 11:59:51 +0200 Subject: [PATCH 3/7] minor tweak --- src/kit/build-start-package.md | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/src/kit/build-start-package.md b/src/kit/build-start-package.md index b9b51847..447e0a37 100644 --- a/src/kit/build-start-package.md +++ b/src/kit/build-start-package.md @@ -1,8 +1,6 @@ # `kit build-start-package` -`kit build-start-package` builds, installs and starts the indicated package directory, or the current working directory if none supplied - - e.g., +`kit build-start-package` builds, installs and starts the indicated package directory, or the current working directory if none supplied, e.g., ``` kit build-start-package foo From 9be8f16b23b3428d2f93468e894bce86af142292 Mon Sep 17 00:00:00 2001 From: jurij-jukic Date: Fri, 10 May 2024 19:16:08 +0200 Subject: [PATCH 4/7] apply changes --- src/kit/build-start-package.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/src/kit/build-start-package.md b/src/kit/build-start-package.md index 447e0a37..709bc524 100644 --- a/src/kit/build-start-package.md +++ b/src/kit/build-start-package.md @@ -14,7 +14,7 @@ kit build-start-package ## Discussion -`kit build-start-package` runs `kit build` followed by `kit start-package`. +`kit build-start-package` runs [`kit build`](./build.md) followed by [`kit start-package`](./start-package.md). ## Arguments @@ -73,3 +73,5 @@ short: `-s` Don't check for dependencies. ### `--features` + +Build the package with the given [cargo features](https://doc.rust-lang.org/cargo/reference/features.html). From 33fabe69c8f870097bb4759a262b6a170fd531fd Mon Sep 17 00:00:00 2001 From: jurij-jukic Date: Mon, 13 May 2024 10:21:31 +0200 Subject: [PATCH 5/7] wip --- src/kit/build-start-package.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/src/kit/build-start-package.md b/src/kit/build-start-package.md index 709bc524..90d42b66 100644 --- a/src/kit/build-start-package.md +++ b/src/kit/build-start-package.md @@ -73,5 +73,8 @@ short: `-s` Don't check for dependencies. ### `--features` - +FEATURES WIP Build the package with the given [cargo features](https://doc.rust-lang.org/cargo/reference/features.html). + +Features can be used like [so](https://doc.rust-lang.org/cargo/reference/features.html#command-line-feature-options). +Currently the only system-wide supported feature is `simulation-mode`. \ No newline at end of file From 66cc59c0dea279af6a46623007f409b065f9b888 Mon Sep 17 00:00:00 2001 From: jurij-jukic Date: Mon, 13 May 2024 11:11:28 +0200 Subject: [PATCH 6/7] apply changes --- src/kit-dev-toolkit.md | 3 ++- src/kit/build-start-package.md | 5 ++--- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/src/kit-dev-toolkit.md b/src/kit-dev-toolkit.md index e326fc4b..d5db0d0f 100644 --- a/src/kit-dev-toolkit.md +++ b/src/kit-dev-toolkit.md @@ -9,7 +9,8 @@ * [`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 build-start-package`](./kit/build-start-package.md) +* [`kit remove-package`](./kit/remove-package.md) * [`kit dev-ui`](./kit/dev-ui.md) * [`kit inject-message`](./kit/inject-message.md) * [`kit run-tests`](./kit/run-tests.md) diff --git a/src/kit/build-start-package.md b/src/kit/build-start-package.md index 90d42b66..e73661e4 100644 --- a/src/kit/build-start-package.md +++ b/src/kit/build-start-package.md @@ -73,8 +73,7 @@ short: `-s` Don't check for dependencies. ### `--features` -FEATURES WIP Build the package with the given [cargo features](https://doc.rust-lang.org/cargo/reference/features.html). -Features can be used like [so](https://doc.rust-lang.org/cargo/reference/features.html#command-line-feature-options). -Currently the only system-wide supported feature is `simulation-mode`. \ No newline at end of file +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`. \ No newline at end of file From 2c1c51e536872122dd13e265457e7a519cdd43fd Mon Sep 17 00:00:00 2001 From: jurij-jukic Date: Mon, 13 May 2024 11:17:29 +0200 Subject: [PATCH 7/7] nit --- src/kit/build-start-package.md | 1 + 1 file changed, 1 insertion(+) diff --git a/src/kit/build-start-package.md b/src/kit/build-start-package.md index e73661e4..d31d5114 100644 --- a/src/kit/build-start-package.md +++ b/src/kit/build-start-package.md @@ -73,6 +73,7 @@ short: `-s` Don't check for dependencies. ### `--features` + 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).