@piperace/cli 1.5.11 → 1.5.13
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 +57 -22
- package/package.json +9 -8
package/README.md
CHANGED
|
@@ -1,48 +1,82 @@
|
|
|
1
1
|
# Piperace
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
**The missing toolkit for localhost.** Public tunnels, trusted local HTTPS
|
|
4
|
+
domains and traffic inspection — one binary, one command. No config, no cloud.
|
|
4
5
|
|
|
5
6
|
🌐 **[piperace.com](https://piperace.com)**
|
|
6
7
|
|
|
7
|
-

|
|
8
|
-
|
|
9
8
|
## Install
|
|
10
9
|
|
|
11
10
|
```bash
|
|
12
11
|
npm install -g @piperace/cli
|
|
13
12
|
```
|
|
14
13
|
|
|
15
|
-
|
|
14
|
+
Works out of the box, no account required. `piperace login` keeps a stable
|
|
15
|
+
subdomain and a permanent token.
|
|
16
|
+
|
|
17
|
+
## The three things it does
|
|
18
|
+
|
|
19
|
+
**Share a local port.** A real HTTPS URL for anything running on your machine,
|
|
20
|
+
through a tunnel that dials out — nothing on your side starts listening on the
|
|
21
|
+
network.
|
|
16
22
|
|
|
17
23
|
```bash
|
|
18
|
-
piperace http 3000 -d myapp #
|
|
19
|
-
piperace
|
|
20
|
-
piperace
|
|
21
|
-
piperace --version
|
|
24
|
+
piperace http 3000 -d myapp # → https://myapp.piperace.fun
|
|
25
|
+
piperace http 3000 8000 9000 # several ports at once
|
|
26
|
+
piperace tcp 5432 # raw TCP, or `tls` for a terminated tunnel
|
|
22
27
|
```
|
|
23
28
|
|
|
24
|
-
|
|
29
|
+
**Serve it locally over real HTTPS.** A trusted certificate on a `.local`
|
|
30
|
+
domain, offline, with no tunnel involved — for the code paths that only run
|
|
31
|
+
under HTTPS: secure cookies, service workers, WebAuthn, mixed-content rules.
|
|
32
|
+
|
|
33
|
+
```bash
|
|
34
|
+
piperace local 3000 -d myapp # → https://myapp.local
|
|
35
|
+
piperace local web:3000 api:8001 # several apps, one command
|
|
36
|
+
```
|
|
25
37
|
|
|
26
|
-
|
|
38
|
+
**See every request.** Traffic through either of the above is captured and
|
|
39
|
+
browsable: method, status, timing, headers and bodies, with secrets redacted.
|
|
40
|
+
From there you can replay a request, mock a response, or inject a fault to see
|
|
41
|
+
how your app handles one.
|
|
27
42
|
|
|
28
|
-
|
|
43
|
+
```bash
|
|
44
|
+
piperace ui # the Control Center: domains, tunnels, Inspect, settings
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
## For AI agents
|
|
48
|
+
|
|
49
|
+
Piperace ships an **MCP server**, so an agent can read the captured traffic
|
|
50
|
+
rather than be told about it — "why did that request 500?" answered from the
|
|
51
|
+
real request and response.
|
|
52
|
+
|
|
53
|
+
```bash
|
|
54
|
+
claude mcp add piperace -- piperace mcp
|
|
55
|
+
```
|
|
29
56
|
|
|
30
|
-
The
|
|
57
|
+
The Control Center can also expose a small, explicit set of commands you allow
|
|
58
|
+
(`docker ps`, `tail`, `systemctl status`) to an agent on another machine.
|
|
59
|
+
There is no shell behind it: a command is a program plus typed parameters, so a
|
|
60
|
+
value can never turn into another command, and anything not on the list waits
|
|
61
|
+
for you to approve it.
|
|
62
|
+
|
|
63
|
+
## Supported platforms
|
|
31
64
|
|
|
32
|
-
| OS | Architecture
|
|
33
|
-
|
|
34
|
-
| macOS | Apple Silicon (arm64)
|
|
35
|
-
| macOS | Intel (x64)
|
|
36
|
-
| Linux | arm64
|
|
37
|
-
| Linux | x64
|
|
38
|
-
| Windows | x64
|
|
39
|
-
| Windows | ia32
|
|
65
|
+
| OS | Architecture |
|
|
66
|
+
|---------|-----------------------|
|
|
67
|
+
| macOS | Apple Silicon (arm64) |
|
|
68
|
+
| macOS | Intel (x64) |
|
|
69
|
+
| Linux | arm64 |
|
|
70
|
+
| Linux | x64 |
|
|
71
|
+
| Windows | x64 |
|
|
72
|
+
| Windows | ia32 |
|
|
40
73
|
|
|
41
74
|
## Environment variables
|
|
42
75
|
|
|
43
76
|
- `PIPERACE_ENV` — `development` or `production` (selects the API/tunnel endpoints).
|
|
44
77
|
- `PIPERACE_BINARY_PATH` — use a specific Piperace executable instead of the managed one.
|
|
45
|
-
- `PIPERACE_DOWNLOAD_URL` — override
|
|
78
|
+
- `PIPERACE_DOWNLOAD_URL` — override where Piperace fetches its components
|
|
79
|
+
(default: `https://piperace-downloads.s3.us-east-1.amazonaws.com`).
|
|
46
80
|
|
|
47
81
|
## Programmatic API
|
|
48
82
|
|
|
@@ -56,7 +90,8 @@ await piperace.run(['http', '3000', '-d', 'myapp'], {
|
|
|
56
90
|
|
|
57
91
|
## macOS note
|
|
58
92
|
|
|
59
|
-
If macOS shows an
|
|
93
|
+
If macOS shows an "unidentified developer" warning, Piperace clears the
|
|
94
|
+
quarantine flag automatically on first run so the app can start.
|
|
60
95
|
|
|
61
96
|
## License
|
|
62
97
|
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@piperace/cli",
|
|
3
|
-
"version": "1.5.
|
|
4
|
-
"description": "Piperace —
|
|
3
|
+
"version": "1.5.13",
|
|
4
|
+
"description": "Piperace — the missing toolkit for localhost: public tunnels, trusted local HTTPS domains and traffic inspection, with an MCP server for AI agents. One binary, one command.",
|
|
5
5
|
"main": "lib/index.js",
|
|
6
6
|
"bin": {
|
|
7
7
|
"piperace": "bin/piperace"
|
|
@@ -16,17 +16,18 @@
|
|
|
16
16
|
"ngrok",
|
|
17
17
|
"localhost",
|
|
18
18
|
"expose",
|
|
19
|
-
"cli"
|
|
19
|
+
"cli",
|
|
20
|
+
"https",
|
|
21
|
+
"local-https",
|
|
22
|
+
"inspect",
|
|
23
|
+
"mcp",
|
|
24
|
+
"debugging"
|
|
20
25
|
],
|
|
21
26
|
"author": "Piperace Team",
|
|
22
27
|
"license": "MIT",
|
|
23
28
|
"homepage": "https://piperace.com",
|
|
24
|
-
"repository": {
|
|
25
|
-
"type": "git",
|
|
26
|
-
"url": "https://github.com/piperace/piperace-npm.git"
|
|
27
|
-
},
|
|
28
29
|
"bugs": {
|
|
29
|
-
"
|
|
30
|
+
"email": "support@piperace.com"
|
|
30
31
|
},
|
|
31
32
|
"engines": {
|
|
32
33
|
"node": ">=14.0.0"
|