@tiktok-minis/cli NPM

TikTok Minis CLI

TikTok Minis CLI is a command line tool for managing TikTok Minis projects, providing a complete set of commands for users to easily initialize, check build, debug, and update projects.

install

Please make sure you have installed Node.js and npm. Then, you can globally install TikTok Minis CLI with the following command:

npm install -g @tiktok-minis/cli@latest

Mini Apps

Initialize Mini App

Note: Before using ttdx minis init, you need to already have a frontend project locally. minis init is used to initialize Minis-related content based on an existing frontend project.

Initialize a new TikTok Minis project with the following command, Including the following steps:

Create minis.config.json
Reference and initialize Minis JSSDDK in index.html

ttdx minis init

Build Mini App

Use the following command to rebuild your Minis:

ttdx minis build:after

Debug Mini App

Use the following command to start debug mode, providing debugging support for Mini applications:

ttdx minis debug

Help

If you need to view detailed help information for a certain command, you can use the --help option, for example:

ttdx minis --help

Mini Games

Initialize Mini Game

Note: Before using ttdx minigame init, you need cd your minigame dist directory. Initialize a new TikTok Minis project with the following command, Including the following steps: 1. Create minigame.config.json 2. Reference and initialize Minis JSSDDK in index.html
ttdx minigame init
Debug Mini Game
Use the following command to start debug mode, providing debugging support for Mini games:
ttdx minigame debug
Check Mini Game
Use the following command to check your minigame build:
ttdx minigame check