https://github.com/css-doodle/cli
Command-line tool for css-doodle to preview and generate images/videos.
https://github.com/css-doodle/cli
Last synced: about 1 year ago
JSON representation
Command-line tool for css-doodle to preview and generate images/videos.
- Host: GitHub
- URL: https://github.com/css-doodle/cli
- Owner: css-doodle
- License: mit
- Created: 2024-10-04T02:21:47.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-04-14T01:21:43.000Z (about 1 year ago)
- Last Synced: 2025-04-21T09:22:14.087Z (about 1 year ago)
- Language: JavaScript
- Homepage:
- Size: 241 KB
- Stars: 16
- Watchers: 2
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# @css-doodle/cli
Command-line tool for css-doodle to preview and generate images/videos.
## Installation
```bash
npm install -g @css-doodle/cli
```
>[!NOTE]
> After installation, you can use `cssd` or `css-doodle` command in the terminal.
## Usage
```console
Usage: cssd [options] [command] [source]
Arguments:
source css-doodle source file to preview (same as run command)
Options:
-V, --version output the version number
-h, --help display help for command
Commands:
run Open a window to preview the css|cssd file
render Generate an image from a css|cssd|html file or a CodePen link
generate Generate code using css-doodle generators
config Display/set configurations
use Shorthand to fetch and use a custom version of css-doodle
parse Print the parsed tokens, help to debug in development
upgrade Upgrade CLI to latest version
```
## Commands
### run
Open a window to preview the css-doodle source file. The source file can be either `.css` or `.cssd`.
* `--fullscreen`: Open in fullscreen mode.
```bash
cssd run code.css
cssd run code.css --fullscreen
```
The `run` can be omitted if you just want to preview.
```bash
cssd somefile.css
```
### render
Generate an image/video from the css-doodle source file. The source file can be a `.css`, `.cssd`, `.html` file or CodePen link.
* `-o, --output `: Custom output filename of the generated result
* `-x, --scale `: Scale factor of the generated result, defaults to `2` for images, `1` for videos
* `-s, --selector `: CSS selector to target the rendered node, defaults to `css-doodle`
* `-d, --delay `: Delay time before taking screenshot/screencast, e.g, `2s`
* `-t, --time
```bash
cssd render
cssd render code.css
cssd render code.css -o result.png
cssd render code.css -x 4
cssd render https://codepen.io/yuanchuan/pen/MQEeJo
```
Screen recording:
```bash
cssd render -t 10s
```
By default the generated video is in `webm` format,
you can transform it automatically into `mp4` by adding `--mp4` option,
or use an output filename with `.mp4` extension.
```bash
cssd render -t 10s --mp4
cssd render -o result.mp4
```
### generate
Generate code using css-doodle generators.
* `svg`: Generate SVG code using svg() function.
* `polygon`: Generate CSS polygon() using shape() function.
```bash
cssd generate svg code.css
cssd generate polygon code.css
# read from STDIN
cssd generate polygon
```
### config
Display/set the configurations in key/value pairs.
* `set `: Set a configuration with key/value pair.
* `get `: Get a configuration value by key.
* `unset `: Unset a configuration field.
* `list`: List all configurations.
Recognizable `field` configurations:
* `browserPath`: The path to the browser executable.
* `css-doodle`: The path to the css-doodle to use.
```bash
# show all configurations
cssd config list
# use a custom browser
cssd config set browserPath /Applications/Google\ Chrome.app/Contents/MacOS/Google\ Chrome
# unset
cssd config unset browserPath
# get the value
cssd config get browserPath
# download and use a custom version of css-doodle
cssd config set css-doodle 0.40.6
```
### use
Shorthand of `cssd config set css-doodle `.
* ``: The version of css-doodle to use. It can be a specific version or `latest`.
```bash
cssd use css-doodle@0.40.6
# or just version
cssd use 0.40.6
cssd use latest
```
### upgrade
Upgrade CLI to latest version.
```bash
cssd upgrade
```