repository·master·Indexed 27 days ago
https://github.com/mixn/carbon-now-cliA command-line interface for Carbon (carbon.now.sh) that generates high-quality images of code directly from the terminal. It supports input via files, stdin, or the clipboard, and offers customizable themes, fonts, and presets. Features include an interactive configuration mode, specific line range capture, and options to save images to disk, copy them to the clipboard, or open them in a browser.
To share presets across a project or team, use the --config flag to point to a local JSON configuration file.
Important Notes on Local Configs:
latest-preset key is not written to local config files.carbon-now _unfold.js --config local-config.json --preset darkcarbon-now command generates beautiful images of your code. You can provide input via a file, stdin, or the clipboard.Presets allow you to save and reuse your favorite styling settings.
carbon-now with the --interactive flag. Follow the prompts to configure settings. The resulting configuration is saved to ~/.carbon-now.json.--preset flag followed by the name of your saved preset.Note: latest-preset is a special key in ~/.carbon-now.json that is overwritten after every run, while named presets remain until manually deleted.
You can install carbon-now-cli globally using various package managers or run it directly using npx.
# Bun
bun i -g carbon-now-cli
# pnpm
pnpm i -g carbon-now-cli
# npm
npm i -g carbon-now-cli
# yarn
yarn global add carbon-now-cli
# Run without installing via npx
npx carbon-now-cli <file>You can define custom syntax highlighting colors by adding a custom key to a preset in your ~/.carbon-now.json file. This complies with the CarbonThemeHighlightsInterface.
```json
{
"hacker": {
"backgroundColor": "rgba(0, 255, 0, 1)",
"windowTheme": "bw",
"custom": {
"background": "rgba(0, 0, 0, 1)",
"text": "rgba(0, 255, 0, 1)",
"variable": "rgba(0, 255, 0, 1)",
"attribute": "rgba(0, 255, 0, 1)",
"definition": "rgba(0, 255, 0, 1)",
"keyword": "rgba(0, 255, 0, 1)",
"operator": "rgba(0, 255, 0, 1)",
"property": "rgba(0, 255, 0, 1)",
"number": "rgba(0, 255, 0, 1)",
"string": "rgba(0, 255, 0, 1)",
"comment": "rgba(0, 255, 0, 1)",
"meta": "rgba(0, 255, 0, 1)",
"tag": "rgba(0, 255, 0, 1)"
}
}
}Limitation: Custom theme colors are not applied when using --open-in-browser because they rely on localStorage within the Playwright instance rather than query string parameters.
When running the Carbon CLI in interactive mode, you can configure the visual appearance of your code exports using the following prompt options:
theme: Select the syntax theme (e.g., 3024 Night).windowTheme: Select the window theme (default: none).fontFamily: Select the font family (default: Hack).fontSize: Set the font size (default: 18px).lineHeight: Set the line height (default: 133%).backgroundColor: Set the background color (default: #ADB7C1).paddingVertical: Set vertical padding (default: 0px).paddingHorizontal: Set horizontal padding (default: 0px).widthAdjustment: Auto adjust width? (default: true).squaredImage: Make squared image? (default: false).windowControls: Include window controls? (default: true).lineNumbers: Include line numbers? (default: false).firstLineNumber: If line numbers are enabled, set the starting line number (default: 1).dropShadow: Include drop shadow? (default: false).dropShadowOffsetY: If drop shadow is enabled, set the y-offset (default: 20px).dropShadowBlurRadius: If drop shadow is enabled, set the blur radius (default: 68px).highlight: Highlight certain lines? (default: false).selectedLines: Comma-separated list of lines to highlight (e.g., 4,5,6,7). Default is *.exportSize: Select the export scale (e.g., 2x).type: Select the export format: png or svg (default: png).watermark: Add Carbon watermark? (default: false).save: Save these settings as a preset? (default: false).presetName: Name of the preset using kebab-case (default: uses the latest preset constant).You can pipe content into carbon-now via stdin or pull content directly from your clipboard.
Using stdin:
# Using pbpaste (macOS)
pbpaste | carbon-now
# Using echo
echo '<h1>Hi</h1>' | carbon-nowUsing clipboard:
carbon-now --from-clipboardUse the --start and --end flags to capture only a specific subset of lines from a file. Note that the command will throw an error if --start is greater than --end.
carbon-now _unfold.js --start 3 --end 6Use the --to-clipboard flag to copy the resulting image directly to your clipboard instead of saving it to a file.
Platform Requirements:
xclip. Install via sudo apt-get install xclip.carbon-now _unfold.js --to-clipboardYou can customize a run by specifying a --preset and providing a JSON string of --settings to override specific configuration keys.
carbon-now _unfold.js --preset presentation --settings '{"theme": "nord", "titleBar": "custom-title.js"}'Instead of saving the file to disk, use the --open-in-browser flag to preview the generated image in your default web browser.
carbon-now _unfold.js --start 3 --end 6 --interactive --open-in-browserUse --save-to to specify a directory and --save-as to specify a filename (without extension) for the output image.
carbon-now _unfold.js --start 3 --end 6 --save-to ~/Desktop --save-as example-23 --interactive