Documate CLI Reference ​

create-documate ​

create-documate can let you create a new Documate project without installing CLI.

Usage ​

npm create documate@latest

npm create documate@latest

yarn create documate

yarn create documate

pnpm create documate

pnpm create documate

Options ​

--template

Specify the template to use. For eaxample, to scaffold a VitePress project:

npm create documate@latest --template vitepress

npm create documate@latest --template vitepress

yarn create documate --template vitepress

yarn create documate --template vitepress

pnpm create documate --template vitepress

pnpm create documate --template vitepress

Installing @documate/documate ​

The @documate/documate package will add a documate command for you. You can either install it globally or per project.

Install Globally ​

A global install of @documate/documate will allow you to run the documate command in any project.

npm install @documate/documate --global

npm install @documate/documate --global

yarn global add @documate/documate

yarn global add @documate/documate

pnpm install @documate/documate --global

pnpm install @documate/documate --global

Install Per Project ​

You can pin the version of @documate/documate to your project by installing it as a dev dependency. This is useful if you are collaborating with other developers.

npm install @documate/documate --save-dev

npm install @documate/documate --save-dev

yarn add @documate/documate --dev

yarn add @documate/documate --dev

pnpm install @documate/documate --save-dev

pnpm install @documate/documate --save-dev

documate init ​

Initialize your project with Documate. This command will add the neccessary packages and scripts to your project.

Usage ​

documate init

documate init

Options ​

--framework

Specify the framework of your project. Can be either vue or react.

documate init --framework vue

documate init --framework vue

documate upload ​

Upload your content to backend and generate the knowledge base.

Usage ​

documate upload

documate upload

Options ​

The documate upload command will read the documate.json file in your project root. You can override any of the options in the file by passing the options as command line arguments.

documate upload --exclude "**/README.md"

documate upload --exclude "**/README.md"

See documate.json for full list of options.