Connect Studio to Code

Using the Studio CLI and API

This documentation provides a detailed guide on how to use the Studio CLI and API for managing design tokens efficiently.

Accessing the SDK and CLI Documentation

Tokens Studio publishes documentation for the SDK on our Github. You can refer to the documentation for any questions and tooling you may need. https://tokens-studio.github.io/studio-app/

Accessing documentation within Studio

1. Open the Studio application.

2. Go to your organization dashboard.

3. Click the SDK and CLI button.

Creating an API Key

• Generate a Key:

  • Go to Personal Settings in Studio.

    • Select API Keys (below "Edit Profile").

    • Create a new API key (e.g., "Test Key").

• Copy and Store the Key:

  • Copy the key string and store it securely (e.g., in a password manager or vault).

    • You won’t be able to view the key again after closing the window.

Accessing the API

The API operates on a GraphQL interface. You can use tools like Postman, Curl, or the Apollo Sandbox to interact with it.

Tokens Studio CLIGraphQLPostman

Best Practices

1. Secure API Key Storage:

   • Use a password manager or secure vault.

   • Avoid storing keys in plain text.

2. Automation:

   • Use environment variables to prevent manual prompts in CI pipelines.

3. Explore API Schema:

   • Use Apollo Sandbox for schema introspection before creating complex queries.

This documentation provides an overview of using Studio’s API and CLI effectively. For further assistance, refer to the official SDK and CLI documentation page.