@layoutplatforms/cli 0.1.0 → 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 +36 -0
- package/dist/version.js +1 -1
- package/package.json +10 -3
package/README.md
ADDED
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
# Layout CLI
|
|
2
|
+
|
|
3
|
+
Sign in to your Layout developer account and build against the sandbox from your terminal. It never touches production.
|
|
4
|
+
|
|
5
|
+
```
|
|
6
|
+
npm i -g @layoutplatforms/cli
|
|
7
|
+
layout login
|
|
8
|
+
```
|
|
9
|
+
|
|
10
|
+
Or run it once without installing: `npx @layoutplatforms/cli login`. Node 20 or later.
|
|
11
|
+
|
|
12
|
+
## Commands
|
|
13
|
+
|
|
14
|
+
| Command | What it does |
|
|
15
|
+
|---|---|
|
|
16
|
+
| `layout login` | Sign in with a code you approve in the console. |
|
|
17
|
+
| `layout logout` | Revoke this CLI session and forget it here. |
|
|
18
|
+
| `layout whoami` | Your developer account and this CLI session. |
|
|
19
|
+
| `layout apps list`, `layout apps create` | Your applications. |
|
|
20
|
+
| `layout keys list`, `layout keys create`, `layout keys revoke` | Your sandbox secret key. |
|
|
21
|
+
| `layout webhooks list` | Your webhook endpoints. Add them in the console. |
|
|
22
|
+
| `layout listen --forward-to <url>` | Forward sandbox events to your machine, signed like real webhooks. |
|
|
23
|
+
| `layout trigger <event>` | Send a test event to your endpoints. |
|
|
24
|
+
| `layout test-order` | Run a whole order against a sandbox test restaurant. |
|
|
25
|
+
| `layout usage` | Your limits and what you have used today. |
|
|
26
|
+
| `layout deliveries` | Recent sandbox webhook deliveries. |
|
|
27
|
+
| `layout request-live-access` | Ask Layout to review production access. |
|
|
28
|
+
| `layout docs` | Open the docs. |
|
|
29
|
+
|
|
30
|
+
Every command takes `--json`, so a coding agent can drive it.
|
|
31
|
+
|
|
32
|
+
## What a CLI session can do
|
|
33
|
+
|
|
34
|
+
A CLI session works in sandbox only. It cannot create or read live keys, change live settings, or place a real order. Live access is requested from the CLI and approved by a person in the console.
|
|
35
|
+
|
|
36
|
+
Full reference: https://developer.layout.link/reference/cli
|
package/dist/version.js
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export const VERSION = "0.1.
|
|
1
|
+
export const VERSION = "0.1.1";
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@layoutplatforms/cli",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.1",
|
|
4
4
|
"private": false,
|
|
5
5
|
"description": "The Layout developer CLI: sign in, sandbox apps and keys, forward webhooks, run test orders.",
|
|
6
6
|
"type": "module",
|
|
@@ -16,7 +16,6 @@
|
|
|
16
16
|
"scripts": {
|
|
17
17
|
"build": "tsc -p tsconfig.build.json",
|
|
18
18
|
"typecheck": "tsc --noEmit",
|
|
19
|
-
"lint": "echo \"(lint not yet configured)\"",
|
|
20
19
|
"test": "tsx --test src/*.test.ts",
|
|
21
20
|
"prepublishOnly": "pnpm run build && pnpm run test"
|
|
22
21
|
},
|
|
@@ -25,5 +24,13 @@
|
|
|
25
24
|
},
|
|
26
25
|
"homepage": "https://developer.layout.link/reference/cli",
|
|
27
26
|
"license": "UNLICENSED",
|
|
28
|
-
"author": "Layout, Inc."
|
|
27
|
+
"author": "Layout, Inc.",
|
|
28
|
+
"keywords": [
|
|
29
|
+
"layout",
|
|
30
|
+
"food ordering",
|
|
31
|
+
"pickup",
|
|
32
|
+
"api",
|
|
33
|
+
"cli",
|
|
34
|
+
"webhooks"
|
|
35
|
+
]
|
|
29
36
|
}
|