wawesome 0.0.1 → 0.0.4

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 +122 -0
  2. package/package.json +3 -3
package/README.md ADDED
@@ -0,0 +1,122 @@
1
+ # 🚀 wawesome
2
+
3
+ > Official CLI for building, bundling, and deploying serverless WebAssembly functions on the
4
+ > **[wawesome.io](https://wawesome.io)** platform.
5
+
6
+ [![npm version](https://img.shields.io/npm/v/wawesome.svg?color=cyan)](https://www.npmjs.com/package/wawesome)
7
+ [![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
8
+
9
+ Deploy ultra-fast, lightweight serverless WebAssembly functions directly from your terminal in under 60 seconds.
10
+
11
+ ---
12
+
13
+ ## ⚡ Quick Start
14
+
15
+ ### 1. Create an account
16
+
17
+ Sign up for free at **[https://wawesome.io](https://wawesome.io)** to set up your workspace.
18
+
19
+ ### 2. Authenticate CLI
20
+
21
+ Login via browser OAuth:
22
+
23
+ ```bash
24
+ npx wawesome login
25
+ ```
26
+
27
+ ### 3. Initialize a project
28
+
29
+ Create a new directory and scaffold a WebAssembly TypeScript starter function:
30
+
31
+ ```bash
32
+ mkdir my-wasm-app && cd my-wasm-app
33
+ npx wawesome init
34
+ ```
35
+
36
+ ### 4. Build & Deploy
37
+
38
+ Deploy your serverless function to Wawesome Cloud instantly:
39
+
40
+ ```bash
41
+ npx wawesome deploy
42
+ ```
43
+
44
+ ---
45
+
46
+ ## 📖 Command Reference
47
+
48
+ | Command | Description |
49
+ |:-----------------------------------|:--------------------------------------------------------------------|
50
+ | `npx wawesome login` | Authenticate CLI with your Wawesome account via browser |
51
+ | `npx wawesome logout` | Log out and clear saved credentials from your machine |
52
+ | `npx wawesome whoami` | View current logged-in user, workspace, and gateway info |
53
+ | `npx wawesome init` | Scaffold a new serverless function project in the current directory |
54
+ | `npx wawesome build` | Bundle TypeScript entry code into an optimized JS bundle |
55
+ | `npx wawesome deploy` | Build, upload, and promote a function version to production |
56
+ | `npx wawesome version list` | List version history for the current function |
57
+ | `npx wawesome version switch <v>` | Roll back or promote a specific function version |
58
+ | `npx wawesome env list` | View environment variables for the current app |
59
+ | `npx wawesome env set <key> <val>` | Set an environment variable (add `--secret` for write-only) |
60
+ | `npx wawesome env rm <key>` | Delete an environment variable |
61
+
62
+ ---
63
+
64
+ ## ⚙️ Configuration & Custom Gateway
65
+
66
+ ### `wawesome-function.json`
67
+
68
+ Every project directory includes a `wawesome-function.json` file generated during `npx wawesome init`:
69
+
70
+ ```json
71
+ {
72
+ "app": "my-app",
73
+ "function": "hello-world",
74
+ "entry": "src/index.ts"
75
+ }
76
+ ```
77
+
78
+ ### Local Development / Gateway Overrides
79
+
80
+ If you are running a local gateway or self-hosted instance, you can configure your CLI Gateway URL using any of the
81
+ following:
82
+
83
+ #### 1. Custom Settings (`~/.wawesome/settings.json`)
84
+
85
+ Create `~/.wawesome/settings.json`:
86
+
87
+ ```json
88
+ {
89
+ "gateway_url": "http://localhost:3000"
90
+ }
91
+ ```
92
+
93
+ #### 2. Environment Variables
94
+
95
+ ```bash
96
+ export WAWESOME_GATEWAY_URL="http://localhost:3000"
97
+ ```
98
+
99
+ #### 3. CLI Flag
100
+
101
+ ```bash
102
+ npx wawesome login --gateway http://localhost:3000
103
+ ```
104
+
105
+ ---
106
+
107
+ ## 🔒 Security & Secrets
108
+
109
+ Wawesome encrypts environment variables at rest using two-tier envelope encryption (AES-256-GCM with per-app data keys
110
+ and AAD context binding). Use `--secret` when setting sensitive keys:
111
+
112
+ ```bash
113
+ npx wawesome env set STRIPE_SECRET_KEY sk_live_xxx --secret
114
+ ```
115
+
116
+ ---
117
+
118
+ ## 🌐 Resources & Support
119
+
120
+ - **Platform Homepage**: [https://wawesome.io](https://wawesome.io)
121
+ - **Documentation**: [https://docs.wawesome.io](https://docs.wawesome.io)
122
+ - **License**: MIT
package/package.json CHANGED
@@ -1,10 +1,10 @@
1
1
  {
2
2
  "name": "wawesome",
3
- "version": "0.0.1",
3
+ "version": "0.0.4",
4
4
  "description": "CLI tool for building and deploying serverless functions on wawesome.io platform",
5
5
  "type": "module",
6
6
  "bin": {
7
- "wawesome": "./bin/wawesome.js"
7
+ "wawesome": "bin/wawesome.js"
8
8
  },
9
9
  "main": "./dist/index.mjs",
10
10
  "types": "./dist/index.d.mts",
@@ -16,7 +16,7 @@
16
16
  "build": "tsdown",
17
17
  "dev": "tsdown --watch",
18
18
  "test": "vitest run",
19
- "check": "publint",
19
+ "check": "publint --pack npm",
20
20
  "changeset": "changeset"
21
21
  },
22
22
  "dependencies": {