@remotedraw/cli 0.2.1 → 0.3.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 +36 -6
- package/dist/cli.d.ts +17 -5
- package/dist/cli.d.ts.map +1 -1
- package/dist/cli.js +261 -64
- package/dist/cloud.d.ts +1 -1
- package/dist/cloud.d.ts.map +1 -1
- package/dist/generated/agent-skill.d.ts +1 -1
- package/dist/generated/agent-skill.d.ts.map +1 -1
- package/dist/generated/agent-skill.js +1 -1
- package/dist/index.js +1 -1
- package/dist/locales/en.d.ts +27 -12
- package/dist/locales/en.d.ts.map +1 -1
- package/dist/locales/en.js +27 -12
- package/dist/locales/index.d.ts +28 -13
- package/dist/locales/index.d.ts.map +1 -1
- package/dist/locales/nl.d.ts.map +1 -1
- package/dist/locales/nl.js +26 -11
- package/dist/packageManagers.d.ts +75 -0
- package/dist/packageManagers.d.ts.map +1 -0
- package/dist/packageManagers.js +146 -0
- package/dist/scan.d.ts +77 -0
- package/dist/scan.d.ts.map +1 -0
- package/dist/scan.js +563 -0
- package/dist/telemetry.d.ts +1 -1
- package/dist/telemetry.d.ts.map +1 -1
- package/dist/update.d.ts +11 -5
- package/dist/update.d.ts.map +1 -1
- package/dist/update.js +55 -28
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -7,17 +7,25 @@ for your chosen stack.
|
|
|
7
7
|
|
|
8
8
|
## Install
|
|
9
9
|
|
|
10
|
-
RemoteDraw requires Node.js 20 or newer.
|
|
10
|
+
RemoteDraw requires Node.js 20 or newer. Use whichever package manager your
|
|
11
|
+
project already uses — the CLI reads the project's lockfile and `packageManager`
|
|
12
|
+
field, and prints its own next steps in that manager's commands.
|
|
11
13
|
|
|
12
14
|
```sh
|
|
13
|
-
npm install
|
|
15
|
+
npm install -g @remotedraw/cli # npm
|
|
16
|
+
pnpm add -g @remotedraw/cli # pnpm
|
|
17
|
+
bun add -g @remotedraw/cli # bun
|
|
14
18
|
remotedraw --version
|
|
15
19
|
```
|
|
16
20
|
|
|
17
|
-
|
|
21
|
+
Yarn Berry has no global install, so run it straight from the registry — which
|
|
22
|
+
also works everywhere else, when you would rather not install anything:
|
|
18
23
|
|
|
19
24
|
```sh
|
|
20
|
-
|
|
25
|
+
yarn dlx @remotedraw/cli # Yarn
|
|
26
|
+
npx @remotedraw/cli@latest # npm
|
|
27
|
+
pnpm dlx @remotedraw/cli # pnpm
|
|
28
|
+
bunx @remotedraw/cli # bun
|
|
21
29
|
```
|
|
22
30
|
|
|
23
31
|
## Start here
|
|
@@ -159,8 +167,10 @@ remotedraw update # install the latest published version
|
|
|
159
167
|
remotedraw update --check # report it without installing
|
|
160
168
|
```
|
|
161
169
|
|
|
162
|
-
`update` detects whether the binary came from npm, pnpm, yarn, or bun and
|
|
163
|
-
|
|
170
|
+
`update` detects whether the binary came from npm, pnpm, yarn, or bun — and
|
|
171
|
+
whether it was run through `npx`/`pnpm dlx`/`yarn dlx`/`bunx`, which fetch the
|
|
172
|
+
latest release every time and so have nothing to update — then runs that
|
|
173
|
+
manager's own command. Other commands check the registry at most once a day and
|
|
164
174
|
print a one-line notice when a newer version exists; that notice only appears on
|
|
165
175
|
an interactive terminal, and `REMOTEDRAW_CLI_NO_UPDATE_CHECK=1`, `CI`, or
|
|
166
176
|
`NO_UPDATE_NOTIFIER` disable it.
|
|
@@ -235,6 +245,24 @@ remotedraw agent --path .agents/skills/remotedraw --force
|
|
|
235
245
|
remotedraw agent --path .claude/skills/remotedraw --force
|
|
236
246
|
```
|
|
237
247
|
|
|
248
|
+
Before scaffolding into an existing app, read it first. `scan` names the web,
|
|
249
|
+
server, and iOS projects in a tree, where an `rd_sk_` key may live, any
|
|
250
|
+
RemoteDraw wiring already present, the integration options that fit, and the
|
|
251
|
+
product questions to settle with the user before building:
|
|
252
|
+
|
|
253
|
+
```sh
|
|
254
|
+
remotedraw scan --format json
|
|
255
|
+
remotedraw scan --path apps/customer-web
|
|
256
|
+
```
|
|
257
|
+
|
|
258
|
+
When the integration already has its files and only needs credentials,
|
|
259
|
+
provision without scaffolding (and without `--force`):
|
|
260
|
+
|
|
261
|
+
```sh
|
|
262
|
+
remotedraw project create --name "Field Notes" --env server # writes server/.env.local
|
|
263
|
+
remotedraw project create --name "Field Notes" --format json # prints the key once
|
|
264
|
+
```
|
|
265
|
+
|
|
238
266
|
## Command reference
|
|
239
267
|
|
|
240
268
|
```text
|
|
@@ -251,6 +279,8 @@ doctor Check project config, packages, and environment variables.
|
|
|
251
279
|
create-input Create or print a test input request payload.
|
|
252
280
|
examples List or install example projects.
|
|
253
281
|
agent Print or install the RemoteDraw agent skill.
|
|
282
|
+
scan Read a codebase and propose where RemoteDraw fits.
|
|
283
|
+
project Create a dashboard project and API key without scaffolding.
|
|
254
284
|
```
|
|
255
285
|
|
|
256
286
|
Run `remotedraw <command> --help` for command-specific options.
|
package/dist/cli.d.ts
CHANGED
|
@@ -2,8 +2,8 @@ import { type WizardDefinition, type WizardTerminal } from "./setup-wizard.js";
|
|
|
2
2
|
import { type CloudRuntime } from "./cloud.js";
|
|
3
3
|
import { type UpdateRuntime } from "./update.js";
|
|
4
4
|
export declare const CLI_VERSION: string;
|
|
5
|
-
export declare const REMOTEDRAW_SDK_RANGE = "^0.
|
|
6
|
-
export declare const REMOTEDRAW_CLI_RANGE = "^0.
|
|
5
|
+
export declare const REMOTEDRAW_SDK_RANGE = "^0.3.0";
|
|
6
|
+
export declare const REMOTEDRAW_CLI_RANGE = "^0.3.0";
|
|
7
7
|
export type CliResult = {
|
|
8
8
|
exitCode: number;
|
|
9
9
|
stdout: string;
|
|
@@ -64,7 +64,9 @@ export declare function createRemoteDrawProject(plan: IntegrationPlan, outputDir
|
|
|
64
64
|
dryRun?: boolean;
|
|
65
65
|
force?: boolean;
|
|
66
66
|
}): Promise<string[]>;
|
|
67
|
-
export declare function projectSetupDefinition(
|
|
67
|
+
export declare function projectSetupDefinition(detected?: {
|
|
68
|
+
packageManager?: PackageManagerChoice;
|
|
69
|
+
}): WizardDefinition;
|
|
68
70
|
type PayloadOptions = {
|
|
69
71
|
preset: PresetChoice;
|
|
70
72
|
label: string;
|
|
@@ -76,8 +78,6 @@ export declare function createSessionPayload(options: PayloadOptions): {
|
|
|
76
78
|
externalId: string;
|
|
77
79
|
markupPreset: "approval" | "sketch" | "photoMarkup" | "pdfMarkup" | "mapMarkup" | "screenMarkup" | "designReview" | "pointer";
|
|
78
80
|
target: {
|
|
79
|
-
kind: string;
|
|
80
|
-
label: string;
|
|
81
81
|
metadata: {
|
|
82
82
|
descriptor: {
|
|
83
83
|
version: number;
|
|
@@ -107,6 +107,18 @@ export declare function createSessionPayload(options: PayloadOptions): {
|
|
|
107
107
|
};
|
|
108
108
|
};
|
|
109
109
|
};
|
|
110
|
+
coordinateSpace?: {
|
|
111
|
+
width: number;
|
|
112
|
+
height: number;
|
|
113
|
+
bounds: {
|
|
114
|
+
minX: number;
|
|
115
|
+
minY: number;
|
|
116
|
+
maxX: number;
|
|
117
|
+
maxY: number;
|
|
118
|
+
};
|
|
119
|
+
};
|
|
120
|
+
kind: string;
|
|
121
|
+
label: string;
|
|
110
122
|
};
|
|
111
123
|
};
|
|
112
124
|
/**
|
package/dist/cli.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"cli.d.ts","sourceRoot":"","sources":["../src/cli.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"cli.d.ts","sourceRoot":"","sources":["../src/cli.ts"],"names":[],"mappings":"AASA,OAAO,EAIL,KAAK,gBAAgB,EAGrB,KAAK,cAAc,EAEpB,MAAM,mBAAmB,CAAC;AAC3B,OAAO,EAaL,KAAK,YAAY,EAElB,MAAM,YAAY,CAAC;AA0BpB,OAAO,EAOL,KAAK,aAAa,EACnB,MAAM,aAAa,CAAC;AAMrB,eAAO,MAAM,WAAW,QAGT,CAAC;AAQhB,eAAO,MAAM,oBAAoB,WAAW,CAAC;AAC7C,eAAO,MAAM,oBAAoB,WAAW,CAAC;AAE7C,MAAM,MAAM,SAAS,GAAG;IACtB,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB,CAAC;AAIF,MAAM,MAAM,YAAY,CAAC,CAAC,SAAS,MAAM,GAAG,MAAM,IAAI;IACpD,KAAK,EAAE,CAAC,CAAC;IACT,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,MAAM,CAAC;CACf,CAAC;AAEF,MAAM,MAAM,mBAAmB,CAAC,CAAC,SAAS,MAAM,IAAI;IAClD,OAAO,EAAE,MAAM,CAAC;IAChB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,YAAY,CAAC,EAAE,CAAC,CAAC;IACjB,OAAO,EAAE,SAAS,YAAY,CAAC,CAAC,CAAC,EAAE,CAAC;CACrC,CAAC;AAEF,MAAM,MAAM,iBAAiB,GAAG;IAC9B,OAAO,EAAE,MAAM,CAAC;IAChB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,MAAM,GAAG,SAAS,CAAC;CAClD,CAAC;AAEF,MAAM,MAAM,WAAW,GAAG;IACxB,KAAK,CAAC,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAChD,IAAI,EAAE,CAAC,OAAO,EAAE,iBAAiB,KAAK,OAAO,CAAC,MAAM,CAAC,CAAC;IACtD,MAAM,EAAE,CAAC,CAAC,SAAS,MAAM,EAAE,OAAO,EAAE,mBAAmB,CAAC,CAAC,CAAC,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;CAC3E,CAAC;AAEF,MAAM,MAAM,UAAU,GAAG,YAAY,GACnC,aAAa,GAAG;IACd,GAAG,EAAE,MAAM,CAAC;IACZ,4EAA4E;IAC5E,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,WAAW,CAAC;IACtB,cAAc,CAAC,EAAE,cAAc,GAAG,SAAS,CAAC;CAC7C,CAAC;AAEJ,eAAO,MAAM,aAAa,gDAAiD,CAAC;AAC5E,eAAO,MAAM,aAAa,oEAKhB,CAAC;AACX,eAAO,MAAM,UAAU,yDAMb,CAAC;AACX,QAAA,MAAM,aAAa,qHAST,CAAC;AAOX,QAAA,MAAM,qBAAqB,yCAAoB,CAAC;AAEhD,KAAK,YAAY,GAAG,CAAC,OAAO,aAAa,CAAC,CAAC,MAAM,CAAC,CAAC;AACnD,KAAK,YAAY,GAAG,CAAC,OAAO,aAAa,CAAC,CAAC,MAAM,CAAC,CAAC;AACnD,KAAK,SAAS,GAAG,CAAC,OAAO,UAAU,CAAC,CAAC,MAAM,CAAC,CAAC;AAC7C,KAAK,YAAY,GAAG,CAAC,OAAO,aAAa,CAAC,CAAC,MAAM,CAAC,CAAC;AAEnD,KAAK,oBAAoB,GAAG,CAAC,OAAO,qBAAqB,CAAC,CAAC,MAAM,CAAC,CAAC;AAEnE,MAAM,MAAM,eAAe,GAAG;IAC5B,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,YAAY,CAAC;IACrB,MAAM,EAAE,YAAY,CAAC;IACrB,GAAG,EAAE,SAAS,CAAC;IACf,MAAM,EAAE,YAAY,CAAC;IACrB,UAAU,EAAE,MAAM,CAAC;IACnB,cAAc,EAAE,oBAAoB,CAAC;CACtC,CAAC;AAaF,wBAAgB,iBAAiB,IAAI,UAAU,CAgC9C;AAED,wBAAgB,0BAA0B,CACxC,GAAG,EAAE,MAAM,EACX,GAAG,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC,EACvC,MAAM,GAAE,CAAC,QAAQ,EAAE,MAAM,KAAK,OAAoB,sCASnD;AAsND,wBAAsB,MAAM,CAC1B,IAAI,EAAE,MAAM,EAAE,EACd,OAAO,GAAE,UAAgC,GACxC,OAAO,CAAC,SAAS,CAAC,CAuGpB;AAuhBD,wBAAsB,uBAAuB,CAC3C,IAAI,EAAE,eAAe,EACrB,SAAS,EAAE,MAAM,EACjB,OAAO,EAAE,UAAU,EACnB,OAAO,GAAE;IAAE,MAAM,CAAC,EAAE,OAAO,CAAC;IAAC,KAAK,CAAC,EAAE,OAAO,CAAA;CAAO,qBAOpD;AA0pDD,wBAAgB,sBAAsB,CACpC,QAAQ,GAAE;IAAE,cAAc,CAAC,EAAE,oBAAoB,CAAA;CAAO,GACvD,gBAAgB,CAsDlB;AAypCD,KAAK,cAAc,GAAG;IACpB,MAAM,EAAE,YAAY,CAAC;IACrB,KAAK,EAAE,MAAM,CAAC;IACd,UAAU,EAAE,MAAM,CAAC;IACnB,WAAW,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CAClC,CAAC;AAuCF,wBAAgB,oBAAoB,CAAC,OAAO,EAAE,cAAc;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAmB3D;AA+FD;;;;;GAKG;AACH,wBAAgB,kBAAkB,WAEjC"}
|