Getting started¶

Token Flow Manager runs on your computer and opens a dashboard in your browser. You only need Node.js 20 or newer installed (download it here).

1. Install¶

Open a terminal and run:

npm install -g token-flow-manager

That installs the tokenflow command on your computer. You only do this once.

2. Launch¶

From now on, just type:

tokenflow

A welcome screen opens in your browser. Pick a recent project or browse for a folder.

Open a project directly

You can also point it straight at a project folder:

tokenflow ./my-design-tokens

Prefer not to install?

Run it once-off without installing anything:

npx token-flow-manager

Other commands¶

tokenflow validate    # check your tokens, exits with an error if something is wrong
tokenflow init        # create a tokenflow.config.json in the current folder

Configuration¶

Token Flow Manager reads two files:

manifest.json: your token organization (collections and modes).
tokenflow.config.json: tool preferences only. Create one with tokenflow init.

Install from a file (offline)¶

No access to the npm registry? Download the token-flow-manager-<version>.tgz from the Releases page, then install it from the folder where you saved it:

npm install -g ./token-flow-manager-0.1.1.tgz

Next steps¶

See everything the dashboard can do on the Features page.
Want to build or contribute? Read the Development page.