Edit

Tokens Studio CLI

Tokens Studio offers an NPM package that you can integrate with your systems. This package allows you to connect directly to the Tokens Studio platform and pull tokens directly into your project.

You may find this useful if you use build pipelines and want to ensure that you have the latest token data in your projects during deployments.

Prerequisites:

Key Features of the CLI

  1. Current Features:

    • Pull token sets into local files.

    • Simplify organization and project selection.

  2. Planned Features:

    • Watch Mode: Automatically sync changes from Studio to local files.

    • Release Artifacts: Pull releases directly instead of token sets.

System Requirements

Installing the CLI

1

Using your terminal, navigate to the directory that you want to connect Studio

Example of navigating to a directory
cd ./your-system/projects/my-project

  • Install the npm install @tokens-studio/sdk.

  • If you don’t have a package.json, initialize it first with npm init.

  • Ensure that the node.js version installed is v.22 or above.

2

Initialize your project for NPM

If you don't already have a package.json file, you can create one by running npm init . This allows npm packages to be installed in the directory.

3

Install the package

In your terminal, install the package.

npm install @tokens-studio/sdk --save-dev

If you're using a different package manager, the package remains the same. For example:

Yarn: yarn add @tokens-studio/sdk --dev

PNPM: pnpm install @tokens-studio/sdk --dev

Bun: bun add @tokens-studio/sdk --dev

Using the CLI

Once installed, you can run commands using npx tokensstudio

Available Commands

You can run npx tokensstudio --help to view all available commands from the CLI.

Setting up your project with the CLI

You will need an API key generated from the Tokens Studio platform. If you don't have this available, you can follow these instructions to generate one.

Once installed, you will need to configure the CLI to use your Tokens Studio account.

1

In your terminal, run the setup command

npx tokensstudio setup --host graphql.prod.tokens.studio

2

When prompted, enter your API key.

You can skip the setup step by defined the API KEY as an environment variable when calling the CLI.

3

Select the organization and project

When successful, a .tokensstudio.json file will be created at the root of your project.

4

Pull Tokens into your project

In the .tokensstudio.json file, edit the output property value to be the local project directory where you'd like the tokens to be stored. For example, if your project uses a src directory, you would want to change that to "output": "src/tokens"

Use the pull command to download the tokens from Tokens Studio to your project.

PreviousConnect Studio to CodeNextGraphQL

Last updated