Skip to content

Commit 43e9885

Browse files
committed
Documention updates:
- npx is not supported - package @kosli/cli should be used to install
1 parent 46349ce commit 43e9885

9 files changed

Lines changed: 82 additions & 7 deletions

File tree

docs.kosli.com/content/getting_started/install.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -96,6 +96,9 @@ You can install Kosli CLI system-wide with `npm` from the default registry <http
9696
npm install -g @kosli/cli
9797
```
9898

99+
Using `npx` is currently not supported
100+
101+
99102
{{< /tab >}}
100103

101104
{{< tab "From source" >}}

npm/README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,8 @@ npm install -g @kosli/cli
4949

5050
npm resolves the `optionalDependencies` declared in the wrapper's `package.json` and installs only the platform-specific package that matches the current OS and CPU architecture — all non-matching packages are silently skipped. The wrapper's `bin/kosli` JS shim then locates the binary inside the installed platform package and executes it.
5151

52+
> **`npx` is not supported.** `npx @kosli/cli` does not install optional dependencies, so the platform binary is never fetched and the command fails. Always install the package before running it.
53+
5254
## The `bin/` directories are populated by goreleaser
5355

5456
The platform package `bin/` directories are **not committed to git**. They are populated automatically during the release process by a post-build hook in [`.goreleaser.yml`](../.goreleaser.yml):

npm/cli-darwin-arm64/README.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,11 @@
1-
This is the macOS ARM 64-bit binary for the Kosli CLI (Apple Silicon). See https://github.com/kosli-dev/cli for details.
1+
# @kosli/cli-darwin-arm64
2+
3+
This is the macOS ARM64 platform binary for the Kosli CLI (Apple Silicon). **Do not install this package directly.**
4+
5+
Install the main package instead, which selects the right binary for your platform automatically:
6+
7+
```sh
8+
npm install -g @kosli/cli
9+
```
10+
11+
See the [Kosli CLI repository](https://github.com/kosli-dev/cli) for documentation and source code.

npm/cli-darwin-x64/README.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,11 @@
1-
This is the macOS 64-bit binary for the Kosli CLI. See https://github.com/kosli-dev/cli for details.
1+
# @kosli/cli-darwin-x64
2+
3+
This is the macOS x64 platform binary for the Kosli CLI. **Do not install this package directly.**
4+
5+
Install the main package instead, which selects the right binary for your platform automatically:
6+
7+
```sh
8+
npm install -g @kosli/cli
9+
```
10+
11+
See the [Kosli CLI repository](https://github.com/kosli-dev/cli) for documentation and source code.

npm/cli-linux-arm/README.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,11 @@
1-
This is the Linux ARM 32-bit binary for the Kosli CLI. See https://github.com/kosli-dev/cli for details.
1+
# @kosli/cli-linux-arm
2+
3+
This is the Linux ARM 32-bit platform binary for the Kosli CLI. **Do not install this package directly.**
4+
5+
Install the main package instead, which selects the right binary for your platform automatically:
6+
7+
```sh
8+
npm install -g @kosli/cli
9+
```
10+
11+
See the [Kosli CLI repository](https://github.com/kosli-dev/cli) for documentation and source code.

npm/cli-linux-arm64/README.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,11 @@
1-
This is the Linux ARM 64-bit binary for the Kosli CLI. See https://github.com/kosli-dev/cli for details.
1+
# @kosli/cli-linux-arm64
2+
3+
This is the Linux ARM64 platform binary for the Kosli CLI. **Do not install this package directly.**
4+
5+
Install the main package instead, which selects the right binary for your platform automatically:
6+
7+
```sh
8+
npm install -g @kosli/cli
9+
```
10+
11+
See the [Kosli CLI repository](https://github.com/kosli-dev/cli) for documentation and source code.

npm/cli-linux-x64/README.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,11 @@
1-
This is the Linux 64-bit binary for the Kosli CLI. See https://github.com/kosli-dev/cli for details.
1+
# @kosli/cli-linux-x64
2+
3+
This is the Linux x64 platform binary for the Kosli CLI. **Do not install this package directly.**
4+
5+
Install the main package instead, which selects the right binary for your platform automatically:
6+
7+
```sh
8+
npm install -g @kosli/cli
9+
```
10+
11+
See the [Kosli CLI repository](https://github.com/kosli-dev/cli) for documentation and source code.

npm/cli-win32-arm64/README.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,11 @@
1-
This is the Windows ARM 64-bit binary for the Kosli CLI. See https://github.com/kosli-dev/cli for details.
1+
# @kosli/cli-win32-arm64
2+
3+
This is the Windows ARM64 platform binary for the Kosli CLI. **Do not install this package directly.**
4+
5+
Install the main package instead, which selects the right binary for your platform automatically:
6+
7+
```sh
8+
npm install -g @kosli/cli
9+
```
10+
11+
See the [Kosli CLI repository](https://github.com/kosli-dev/cli) for documentation and source code.

npm/cli-win32-x64/README.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,11 @@
1-
This is the Windows 64-bit binary for the Kosli CLI. See https://github.com/kosli-dev/cli for details.
1+
# @kosli/cli-win32-x64
2+
3+
This is the Windows x64 platform binary for the Kosli CLI. **Do not install this package directly.**
4+
5+
Install the main package instead, which selects the right binary for your platform automatically:
6+
7+
```sh
8+
npm install -g @kosli/cli
9+
```
10+
11+
See the [Kosli CLI repository](https://github.com/kosli-dev/cli) for documentation and source code.

0 commit comments

Comments
 (0)