@shikijs/cli
Shiki in the command line.
Usage
The Shiki CLI works like cat
command, but with syntax highlighting.
bash
npx @shikijs/cli README.md
Install
You can also install it globally. Command aliases @shikijs/cli
, shiki
, skat
are registered.
sh
npm i -g @shikijs/cli
sh
yarn global add @shikijs/cli
sh
pnpm add -g @shikijs/cli
sh
bun add -g @shikijs/cli
sh
skat src/index.ts
Options
--theme
Specify the theme to use. Defaults to vitesse-dark
.
bash
npx @shikijs/cli README.md --theme=nord
--lang
Language is auto-inferred from the file extension. You can override it with --lang
.
bash
npx @shikijs/cli src/index.js --lang=ts
Node.js API
The @shikijs/cli
package also provides a Node.js API.
sh
npm i @shikijs/cli
sh
yarn add @shikijs/cli
sh
pnpm add @shikijs/cli
sh
bun add @shikijs/cli
codeToANSI
The asynchronous codeToANSI
function allows you to convert code to ANSI escape codes for terminal output. This is useful for rendering syntax-highlighted code in the terminal.
ts
import { codeToANSI } from '@shikijs/cli'
const highlighted = await codeToANSI(source, 'typescript', 'nord')
console.log(highlighted)
codeToANSI
takes three required parameters:
code: string
lang: BundledLanguage
theme: BundledTheme