@kitschpatrol/tldraw-cli 4.6.27 → 4.6.29
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/bin/cli.js +511 -203
- package/dist/.DS_Store +0 -0
- package/dist/lib/index.js +509 -201
- package/dist/lib/inline/get-image.d.ts +1 -1
- package/dist/lib/tldraw-to-image.d.ts +1 -1
- package/dist/tldraw/assets/index-B6B9QXXc.js +425 -0
- package/dist/tldraw/index.html +1 -1
- package/package.json +5 -5
- package/readme.md +20 -16
- package/dist/tldraw/assets/index-D-73B8sU.js +0 -425
package/dist/tldraw/index.html
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
<meta charset="UTF-8" />
|
|
5
5
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
|
6
6
|
<title>tldraw via tldraw-cli</title>
|
|
7
|
-
<script type="module" crossorigin src="/assets/index-
|
|
7
|
+
<script type="module" crossorigin src="/assets/index-B6B9QXXc.js"></script>
|
|
8
8
|
<link rel="stylesheet" crossorigin href="/assets/index-DZaxLi12.css">
|
|
9
9
|
</head>
|
|
10
10
|
<body>
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@kitschpatrol/tldraw-cli",
|
|
3
|
-
"version": "4.6.
|
|
3
|
+
"version": "4.6.29",
|
|
4
4
|
"type": "module",
|
|
5
5
|
"description": "A CLI tool for exporting tldraw sketch URLs and local .tldr files to a variety of image formats.",
|
|
6
6
|
"repository": "github:kitschpatrol/tldraw-cli",
|
|
@@ -47,14 +47,14 @@
|
|
|
47
47
|
"devDependencies": {
|
|
48
48
|
"@kitschpatrol/shared-config": "^4.7.12",
|
|
49
49
|
"@sindresorhus/slugify": "^2.2.1",
|
|
50
|
-
"@tldraw/assets": "3.
|
|
50
|
+
"@tldraw/assets": "3.7.2",
|
|
51
51
|
"@types/express": "^4.17.21",
|
|
52
52
|
"@types/node": "18.0.0",
|
|
53
53
|
"@types/react": "^18.3.18",
|
|
54
54
|
"@types/react-dom": "^18.3.5",
|
|
55
55
|
"@types/yargs": "^17.0.33",
|
|
56
56
|
"@vitejs/plugin-react-swc": "^3.7.2",
|
|
57
|
-
"bumpp": "^
|
|
57
|
+
"bumpp": "^10.0.1",
|
|
58
58
|
"chalk": "^5.4.1",
|
|
59
59
|
"cheerio": "^1.0.0",
|
|
60
60
|
"esbuild": "^0.24.2",
|
|
@@ -72,11 +72,11 @@
|
|
|
72
72
|
"sharp": "^0.33.5",
|
|
73
73
|
"sharp-phash": "^2.2.0",
|
|
74
74
|
"strip-ansi": "^7.1.0",
|
|
75
|
-
"tldraw": "3.
|
|
75
|
+
"tldraw": "3.7.2",
|
|
76
76
|
"tsx": "^4.19.2",
|
|
77
77
|
"typescript": "^5.7.3",
|
|
78
78
|
"untildify": "^5.0.0",
|
|
79
|
-
"vite": "^5.4.
|
|
79
|
+
"vite": "^5.4.14",
|
|
80
80
|
"vitest": "^2.1.8"
|
|
81
81
|
},
|
|
82
82
|
"publishConfig": {
|
package/readme.md
CHANGED
|
@@ -19,6 +19,10 @@
|
|
|
19
19
|
|
|
20
20
|
<!-- /description -->
|
|
21
21
|
|
|
22
|
+
> [!IMPORTANT]
|
|
23
|
+
>
|
|
24
|
+
> The tldraw project and website are rapidly evolving, and time is not always avaialbe to keep `tldraw-cli`'s abstractions up to date, particularly for commands that interface directly with sketch URLs. Working with local `.tldr` files should be relatively stable, but caveat emptor.
|
|
25
|
+
|
|
22
26
|
<!-- table-of-contents { maxDepth: 2 } -->
|
|
23
27
|
|
|
24
28
|
## Table of contents
|
|
@@ -115,22 +119,22 @@ tldraw export <files-or-urls..>
|
|
|
115
119
|
| ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------- |
|
|
116
120
|
| `files-or-urls` | The tldraw sketch to export. May be one or more paths to local `.tldr` files, or tldraw\.com sketch URLs. Accepts a mix of both file paths and URLs, and supports glob matching via your shell. Prints the absolute path(s) to the exported image(s) to `stdout`. _(Required.)_ | `array` |
|
|
117
121
|
|
|
118
|
-
| Option | Description | Type
|
|
119
|
-
| ----------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
120
|
-
| `--format`<br>`-f` | Output image format. | `"png"` `"svg"` `"
|
|
121
|
-
| `--output`<br>`-o` | Output image directory. | `string`
|
|
122
|
-
| `--name`<br>`-n` | Output image name (without extension). | `string`
|
|
123
|
-
| `--frames` | Export each sketch "frame" as a separate image. Pass one or more frame names or IDs to export specific frames, or pass the flag without the arguments to export all frames. By default, the entire first page is exported with all frames. | `array`
|
|
124
|
-
| `--pages` | Export each sketch "page" as a separate image. Pass one or more page names or IDs to export specific page, or pass one or more page index numbers (from 0), or pass the flag without the arguments to export all pages. By default, only the first page is exported. | `array`
|
|
125
|
-
| `--transparent`<br>`-t` | Export an image with a transparent background. | `boolean`
|
|
126
|
-
| `--dark`<br>`-d` | Export a dark theme version of the image. | `boolean`
|
|
127
|
-
| `--padding` | Set a specific padding amount around the exported image. | `number`
|
|
128
|
-
| `--scale` | Set a sampling factor for raster image exports. | `number`
|
|
129
|
-
| `--strip-style` | Remove `<style>` elements from SVG output, useful to lighten the load of embedded fonts if you intend to provide your own stylesheets. Applies to SVG output only. | `boolean`
|
|
130
|
-
| `--print`<br>`-p` | Print the exported image(s) to stdout instead of saving to a file. Incompatible with `--output`, and disregards `--name`. PNGs are printed as base64-encoded strings. | `boolean`
|
|
131
|
-
| `--verbose` | Enable verbose logging. All verbose logs and prefixed with their log level and are printed to `stderr` for ease of redirection. | `boolean`
|
|
132
|
-
| `--help`<br>`-h` | Show help | `boolean`
|
|
133
|
-
| `--version`<br>`-v` | Show version number | `boolean`
|
|
122
|
+
| Option | Description | Type | Default |
|
|
123
|
+
| ----------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------ | ----------------------------------------- |
|
|
124
|
+
| `--format`<br>`-f` | Output image format. | `"png"` `"svg"` `"tldr"` | `"svg"` |
|
|
125
|
+
| `--output`<br>`-o` | Output image directory. | `string` | `"./"` |
|
|
126
|
+
| `--name`<br>`-n` | Output image name (without extension). | `string` | The original file name or URL id is used. |
|
|
127
|
+
| `--frames` | Export each sketch "frame" as a separate image. Pass one or more frame names or IDs to export specific frames, or pass the flag without the arguments to export all frames. By default, the entire first page is exported with all frames. | `array` | `false` |
|
|
128
|
+
| `--pages` | Export each sketch "page" as a separate image. Pass one or more page names or IDs to export specific page, or pass one or more page index numbers (from 0), or pass the flag without the arguments to export all pages. By default, only the first page is exported. | `array` | `false` |
|
|
129
|
+
| `--transparent`<br>`-t` | Export an image with a transparent background. | `boolean` | `false` |
|
|
130
|
+
| `--dark`<br>`-d` | Export a dark theme version of the image. | `boolean` | `false` |
|
|
131
|
+
| `--padding` | Set a specific padding amount around the exported image. | `number` | `32` |
|
|
132
|
+
| `--scale` | Set a sampling factor for raster image exports. | `number` | `1` |
|
|
133
|
+
| `--strip-style` | Remove `<style>` elements from SVG output, useful to lighten the load of embedded fonts if you intend to provide your own stylesheets. Applies to SVG output only. | `boolean` | `false` |
|
|
134
|
+
| `--print`<br>`-p` | Print the exported image(s) to stdout instead of saving to a file. Incompatible with `--output`, and disregards `--name`. PNGs are printed as base64-encoded strings. | `boolean` | `false` |
|
|
135
|
+
| `--verbose` | Enable verbose logging. All verbose logs and prefixed with their log level and are printed to `stderr` for ease of redirection. | `boolean` | `false` |
|
|
136
|
+
| `--help`<br>`-h` | Show help | `boolean` | |
|
|
137
|
+
| `--version`<br>`-v` | Show version number | `boolean` | |
|
|
134
138
|
|
|
135
139
|
#### Subcommand: `tldraw open`
|
|
136
140
|
|