samplex 0.1.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.
- package/README.md +71 -0
- package/dist/index.cjs +14659 -0
- package/dist/index.d.ts +1 -0
- package/dist/index.js +14974 -0
- package/package.json +37 -0
package/README.md
ADDED
|
@@ -0,0 +1,71 @@
|
|
|
1
|
+
<p align="center">
|
|
2
|
+
<img src="https://sample.app/assets/sample-logo-white.jpg" alt="samplex" width="120" />
|
|
3
|
+
</p>
|
|
4
|
+
|
|
5
|
+
<h1 align="center">samplex</h1>
|
|
6
|
+
|
|
7
|
+
<p align="center">Deploy static sites to shareable preview URLs from the command line.</p>
|
|
8
|
+
|
|
9
|
+
## Why samplex?
|
|
10
|
+
|
|
11
|
+
- **One command to deploy** — no config files, no CI setup, no waiting
|
|
12
|
+
- **Instant preview URLs** — share a link before your PR is even open
|
|
13
|
+
- **Zero lock-in** — it's just static files on the edge
|
|
14
|
+
|
|
15
|
+
## Quick start
|
|
16
|
+
|
|
17
|
+
```bash
|
|
18
|
+
# Authenticate with your sample.app account
|
|
19
|
+
npx samplex login
|
|
20
|
+
|
|
21
|
+
# Deploy from your build output directory
|
|
22
|
+
npx samplex deploy ./dist
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
Works with any package manager:
|
|
26
|
+
|
|
27
|
+
```bash
|
|
28
|
+
npx samplex login # npm
|
|
29
|
+
bunx samplex login # bun
|
|
30
|
+
pnpm dlx samplex login # pnpm
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
### Optional global install
|
|
34
|
+
|
|
35
|
+
```bash
|
|
36
|
+
npm install -g samplex # or: bun install -g samplex / pnpm install -g samplex
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
## Commands
|
|
40
|
+
|
|
41
|
+
| Command | Description |
|
|
42
|
+
| --- | --- |
|
|
43
|
+
| `samplex login` | Authenticate via browser (OAuth2 + PKCE) |
|
|
44
|
+
| `samplex deploy [dir]` | Deploy a directory to a preview URL |
|
|
45
|
+
| `samplex list` | List your deployed sites |
|
|
46
|
+
| `samplex delete <slug>` | Delete a site by slug |
|
|
47
|
+
| `samplex init` | Initialize or view project config |
|
|
48
|
+
|
|
49
|
+
## Project config
|
|
50
|
+
|
|
51
|
+
Running `samplex deploy` saves a `.samplex.config.json` in your project root so subsequent deploys update the same site. You can also set it manually:
|
|
52
|
+
|
|
53
|
+
```bash
|
|
54
|
+
samplex init --slug my-site --name "My Site"
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
## Options
|
|
58
|
+
|
|
59
|
+
- `--slug <slug>` — Set the site slug (used in the preview URL)
|
|
60
|
+
- `--name <name>` — Set a display name for the site
|
|
61
|
+
- `-v, --version` — Print the CLI version
|
|
62
|
+
|
|
63
|
+
## How it works
|
|
64
|
+
|
|
65
|
+
1. Builds are archived as a `.tar.gz` with a SHA-256 integrity hash
|
|
66
|
+
2. Uploaded to sample.app via authenticated API
|
|
67
|
+
3. Served on a unique preview URL like `my-site--username.sample.app`
|
|
68
|
+
|
|
69
|
+
## License
|
|
70
|
+
|
|
71
|
+
Apache-2.0 — made by [Genmod](https://sample.app)
|