Skip to content

Latest commit

 

History

History
60 lines (35 loc) · 1.72 KB

cli.md

File metadata and controls

60 lines (35 loc) · 1.72 KB

vscat (CLI Guide)

This guide talks about how to use vscat as a command line utility (npm package). To learn about using vscat as an API (Javascript/Typescript), please check the API Guide.

Installation and Usage

Using Yarn

yarn add vscat

yarn vscat [...options]

Using NPM

npm install vscat

npm run vscat [...options]

Common Options

  • -t, --theme: Specifies which VS Code theme to use. Accepts a supported themeId or an explicit theme path. (default: "default-high-contrast")
  • -l, --language: Specifies the programming language. Accepts a supported languageId or an explicit JSON textmate grammar path. (omit to automatically detect)
  • -w, --width: Specifies width (in columns) of rendered output. (omit to automatically detect)
  • -h, --help: display usage help.

vscat [source-file]

Highlights a single source file.

0-0

vscat diff [before-file] [after-file]

Highlights difference between two files.

1-0

vscat diagnostics [source-file]

Highlights a single source file with a diagnostic range.

  • --from <line,column>: Starting position of the diagnostic.
  • --to <line,column> : Ending position of the diagnostic.
  • --severity <severity>: Supports 'error', 'warning', 'info', and 'hint'. (default: "error")

2-0

vscat list-themes

Lists all themes supported by this version.

vscat list-languages

Lists all languages supported by this version.