@shikijs/cli

在命令行中使用 Shiki。

使用方法

Shiki CLI 与 cat 命令类似，不过它会输出具有语法高亮的内容。

npx @shikijs/cli README.md

安装

你可以将它全局安装，命令别名有 @shikijs/cli、shiki 和 skat。

npm

npm i -g @shikijs/cli

yarn

yarn global add @shikijs/cli

pnpm

pnpm add -g @shikijs/cli

bun

bun add -g @shikijs/cli

deno

deno install -gREn skat npm:@shikijs/cli

skat src/index.ts

选项

--theme

指定使用的主题，默认为 vitesse-dark。

npx @shikijs/cli README.md --theme=nord

--lang

语言默认从文件拓展名自动推断，你可以使用 --lang 选项覆盖。

npx @shikijs/cli src/index.js --lang=ts

Node.js API

The @shikijs/cli package also provides a Node.js API.

npm

npm i @shikijs/cli

yarn

yarn add @shikijs/cli

pnpm

pnpm add @shikijs/cli

bun

bun add @shikijs/cli

deno

deno add npm:@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.

import { codeToANSI } from '@shikijs/cli'

const highlighted = await codeToANSI(source, 'typescript', 'nord')

console.log(highlighted)

codeToANSI takes three required parameters:

1. code: string
2. lang: BundledLanguage
3. theme: BundledTheme