@go-labs-sg/event-tech 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.
- package/README.md +68 -0
- package/dist/index.js +15357 -0
- package/package.json +30 -0
package/README.md
ADDED
|
@@ -0,0 +1,68 @@
|
|
|
1
|
+
# Event Tech CLI
|
|
2
|
+
|
|
3
|
+
`@go-labs-sg/event-tech` provides the `event-tech` and `et` commands for working with Event Tech through its permission-aware API.
|
|
4
|
+
|
|
5
|
+
## Runtime and installation
|
|
6
|
+
|
|
7
|
+
The CLI requires [Bun](https://bun.com/docs/installation) 1.4.0 or newer. npm distributes the package, while the installed command runs under Bun.
|
|
8
|
+
|
|
9
|
+
Check whether a compatible Bun version is already available:
|
|
10
|
+
|
|
11
|
+
```bash
|
|
12
|
+
bun --version
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
If Bun is missing, install it for the current operating system:
|
|
16
|
+
|
|
17
|
+
**macOS (Homebrew)**
|
|
18
|
+
|
|
19
|
+
```bash
|
|
20
|
+
brew install oven-sh/bun/bun
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
**Windows (PowerShell)**
|
|
24
|
+
|
|
25
|
+
```powershell
|
|
26
|
+
powershell -c "irm bun.sh/install.ps1|iex"
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
**Linux**
|
|
30
|
+
|
|
31
|
+
```bash
|
|
32
|
+
curl -fsSL https://bun.com/install | bash
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
If Bun is installed but older than 1.4.0, run `bun upgrade`. Open a new terminal if the installer changes `PATH`, then verify `bun --version` again. Installation agents should skip the platform installer when Bun 1.4.0 or newer is already available.
|
|
36
|
+
|
|
37
|
+
Install and verify the CLI:
|
|
38
|
+
|
|
39
|
+
```bash
|
|
40
|
+
bun add --global @go-labs-sg/event-tech
|
|
41
|
+
et version
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
## Authentication
|
|
45
|
+
|
|
46
|
+
```sh
|
|
47
|
+
et auth login
|
|
48
|
+
et auth status
|
|
49
|
+
et auth whoami
|
|
50
|
+
```
|
|
51
|
+
|
|
52
|
+
`et auth login` opens Event Tech in the system browser. Use the normal Event Tech Google-backed web login if needed, verify the displayed code and device, then click **Authorize CLI**. An existing browser session skips another Google login but never skips explicit CLI approval.
|
|
53
|
+
|
|
54
|
+
The terminal polls automatically and stores only Event Tech-issued credentials through `Bun.secrets`. It does not store Google credentials and has no API-key or environment-variable authentication fallback. Use `et auth logout` to revoke the remote session and remove its local credential. For SSH and containers, pass `--no-browser` and open the printed URL elsewhere.
|
|
55
|
+
|
|
56
|
+
Use `EVENT_TECH_API_URL` or `--api-url` to target another HTTPS deployment. Plain HTTP is allowed only for localhost development.
|
|
57
|
+
|
|
58
|
+
## Commands
|
|
59
|
+
|
|
60
|
+
```sh
|
|
61
|
+
et --help
|
|
62
|
+
et organization list
|
|
63
|
+
et organization get --organization-id <id>
|
|
64
|
+
et event list --organization-id <id>
|
|
65
|
+
et event get --event-id <id>
|
|
66
|
+
```
|
|
67
|
+
|
|
68
|
+
Commands emit deterministic JSON envelopes. Authentication credentials are never included in successful output, and bearer credentials are redacted from errors.
|