Skip to main content

Quick Start

Run without installation

To invoke ccht immediately, just run npx ccht <your-site-url> on your terminal. This will temporarily download ccht package and execute it.

$ npx ccht https://example.com

Run as project dependency

If you intented to use ccht more than once or integrate into your project, install ccht locally and invoke it.

$ yarn add -D ccht

# or using npm
$ npm i -D ccht

You can now invoke ccht with npx command or in npm scripts.

# This does not download ccht package,
# since it's already in project's node_modules directory
$ npx ccht https://example.com
package.json
{
"scripts": {
"test-site": "ccht https://example.com"
},
"devDependencies": {
"ccht": "^0.1.1"
}
}

Install globally

caution

We recommend not to install globally, especially if you're working with teams.

Also, you can install it globally and invoke it as global command.

$ npm i -g ccht

# you can now invoke ccht without npx
$ ccht https://example.com