@volcano.dev/cli 0.0.5 → 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +32 -6
  2. package/package.json +2 -2
package/README.md CHANGED
@@ -1,20 +1,44 @@
1
1
  # Volcano CLI
2
2
 
3
- `volcano` is the command-line client for Volcano, Kong's hosting platform. It
4
- helps you scaffold, run, and manage Volcano projects from your terminal.
3
+ Volcano is a hosting platform for building applications with functions,
4
+ databases, and authentication. Deploy backend logic, provision PostgreSQL
5
+ databases, and add user authentication—all through a unified API. The `volcano`
6
+ CLI helps you scaffold, run, and manage Volcano projects from your terminal.
5
7
 
6
8
  ## Quickstart
7
9
 
8
- Install the latest published release:
10
+ Install with npm:
9
11
 
10
12
  ```bash
11
- curl -fsSL https://github.com/Kong/volcano-cli/releases/latest/download/install.sh | bash
13
+ npm install -g @volcano.dev/cli
14
+ volcano --help
12
15
  ```
13
16
 
14
- Or install from npm:
17
+ Or install with pnpm:
15
18
 
16
19
  ```bash
17
- npm install -g @volcano.dev/cli
20
+ pnpm add -g @volcano.dev/cli
21
+ volcano --help
22
+ ```
23
+
24
+ Or install with Bun:
25
+
26
+ ```bash
27
+ bun add -g @volcano.dev/cli
28
+ volcano --help
29
+ ```
30
+
31
+ Or install with Homebrew:
32
+
33
+ ```bash
34
+ brew install Kong/volcano/volcano
35
+ volcano --help
36
+ ```
37
+
38
+ Or install manually:
39
+
40
+ ```bash
41
+ curl -fsSL https://github.com/Kong/volcano-cli/releases/latest/download/install.sh | bash
18
42
  volcano --help
19
43
  ```
20
44
 
@@ -41,6 +65,8 @@ More detail lives in `docs/`:
41
65
  - [Installation details](docs/installation.md)
42
66
  - [Authentication](docs/authentication.md)
43
67
  - [Project configuration](docs/project-configuration.md)
68
+ - [CLI operations overview](docs/cli/overview.md)
69
+ - [Documentation search (`volcano docs`)](docs/docs-search.md)
44
70
 
45
71
  ## Contributing
46
72
 
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@volcano.dev/cli",
3
- "version": "0.0.5",
4
- "description": "Command-line client for Volcano, Kong's hosting platform.",
3
+ "version": "0.1.0",
4
+ "description": "CLI for Volcano's hosting platform.",
5
5
  "keywords": [
6
6
  "volcano",
7
7
  "kong",