setsuna-microvm 0.5.0 → 0.5.1

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 +35 -38
  2. package/package.json +13 -5
package/README.md CHANGED
@@ -1,52 +1,49 @@
1
- # `setsuna-microvm`
1
+ # Setsuna
2
2
 
3
- Customer preview command-line interface for Setsuna microVM sandboxes. The package installs
4
- a single `setsuna` executable. It requires Node.js 24.14.0 or newer.
3
+ Setsuna is a high-performance microVM environment for isolated development and agent workloads.
4
+
5
+ `setsuna-microvm` provides the public Setsuna command-line interface for the Research Preview.
6
+
7
+ ## Research Preview
8
+
9
+ Setsuna is currently available to approved Research Preview users.
10
+
11
+ Installing the CLI does not by itself grant access to the Setsuna service. An authorized Setsuna
12
+ account is required.
13
+
14
+ Learn more and request access at [semswitch.com/setsuna](https://semswitch.com/setsuna).
15
+
16
+ ## Install
17
+
18
+ Node.js 24.14.0 or newer is required.
5
19
 
6
20
  ```sh
7
21
  npm install -g setsuna-microvm
8
- setsuna --help
9
22
  ```
10
23
 
11
- ## Interactive use
24
+ Then start the interactive interface:
12
25
 
13
- Run `setsuna` with no arguments in a terminal to open the interactive interface. It checks your
14
- saved sign-in, refreshing it when possible, offers the browser sign-in otherwise, and then lets
15
- you start a microVM, manage active microVMs, run a command in a fresh microVM, or review your
16
- account and log out. Without a terminal, `setsuna` prints the command list instead.
26
+ ```sh
27
+ setsuna
28
+ ```
17
29
 
18
- ## Commands
30
+ It guides you through signing in, selecting an available microVM configuration, starting and
31
+ managing microVMs, and running commands.
19
32
 
20
- - `setsuna auth login`, `setsuna auth status`, `setsuna auth logout` manage your Setsuna
21
- credentials through the Auth0 Device Flow.
22
- - `setsuna health` and `setsuna configurations` inspect the service and the available microVM
23
- configurations.
24
- - `setsuna create`, `setsuna list`, `setsuna status`, `setsuna renew`, `setsuna exec`, and
25
- `setsuna destroy` manage persistent sandboxes.
26
- - `setsuna shell SANDBOX_ID` opens a PTY-backed shell in a sandbox. Press `Ctrl+]` to detach,
27
- then reattach with `setsuna shell SANDBOX_ID --attach PROCESS_ID`.
28
- - `setsuna process` spawns, lists, attaches to, writes stdin to, or terminates guest processes.
29
- - `setsuna run -- COMMAND` creates a sandbox, executes one command, and always destroys the
30
- sandbox.
33
+ For CLI and automation usage:
34
+
35
+ ```sh
36
+ setsuna --help
37
+ ```
31
38
 
32
- Every command accepts `--json` for machine-readable output where documented in `setsuna --help`.
39
+ ## Authentication
33
40
 
34
- Sign-in keeps the refresh token in Windows Credential Manager, macOS Keychain, or Linux
35
- Secret Service (libsecret and an unlocked user keyring are required on Linux). If secure
36
- storage is unavailable, unlock or enable your OS credential store and retry; there is no
37
- plaintext fallback. `~/.setsuna/auth.json` holds only access-token metadata. Existing v1
38
- credentials migrate automatically after a verified secure write. Logout attempts Auth0
39
- refresh-token revocation for up to five seconds, then clears both local stores regardless of
40
- the remote outcome. It warns when remote revocation cannot be confirmed. Logout JSON retains
41
- `authenticated: false` and reports `remoteRevocation` as `confirmed`, `unconfirmed`, or
42
- `not-needed` when there is no saved session/token to revoke.
41
+ Setsuna uses browser-based authentication. Long-lived credentials are stored using the operating
42
+ system's native secure credential storage, with no plaintext fallback.
43
43
 
44
- ## Remote access
44
+ ## Preview status
45
45
 
46
- Log in first, then run commands against the authenticated Setsuna preview service:
46
+ This package is distributed as a Research Preview. Features, commands, and service behavior may
47
+ evolve before the stable Setsuna release.
47
48
 
48
- ```sh
49
- setsuna auth login
50
- setsuna health
51
- setsuna run -- uname -a
52
- ```
49
+ Copyright © SemSwitch, Inc. Licensed under Apache-2.0.
package/package.json CHANGED
@@ -1,12 +1,20 @@
1
1
  {
2
2
  "name": "setsuna-microvm",
3
- "version": "0.5.0",
3
+ "version": "0.5.1",
4
4
  "description": "Customer preview command-line interface for Setsuna microVM sandboxes.",
5
5
  "license": "Apache-2.0",
6
- "repository": {
7
- "type": "git",
8
- "url": "https://github.com/semswitch/setsuna-microvm.git"
9
- },
6
+ "homepage": "https://semswitch.com/setsuna",
7
+ "keywords": [
8
+ "setsuna",
9
+ "microvm",
10
+ "cli",
11
+ "sandbox",
12
+ "firecracker",
13
+ "development-environment",
14
+ "isolated-compute",
15
+ "developer-tools",
16
+ "cloud-infrastructure"
17
+ ],
10
18
  "type": "module",
11
19
  "engines": {
12
20
  "node": ">=24.14.0"