LogoLogo
Release notesDocs homeFabricateTonic.ai
  • Tonic Fabricate User Guide
  • Fabricate workflow
  • Tutorial videos
  • Fabricate account
    • Getting started with Fabricate
    • Fabricate license plans
    • Managing your Fabricate account and profile
    • Managing users in your account
  • Databases
    • Supported database types
    • Creating and managing databases
  • Backing up and restoring the database definition
  • Configuring database variables
  • Exporting data from a database
  • Tables and columns
    • Managing database tables
      • Configuring table settings
      • Adding a table to a database
      • Removing a table from a database
      • Attaching static data to a table
      • Regenerating table data
  • Managing table columns
    • Adding and removing columns
    • Configuring a column
    • Generator reference
      • Calculated or related values
      • Data type and specific values
      • Names and other identifying information
      • Telephone numbers and email addresses
      • Geographic locations
      • Air travel
      • Natural science
      • Networks and files
      • Banking and finance
      • Dates and times
      • Vehicles
      • Companies and products
      • Healthcare and health insurance
      • Languages
      • Movies
      • Education
  • Views
    • Creating and managing views
    • Views reference
  • Workspaces
    • About workspaces
  • Creating and managing workspaces
  • Database mock API
    • About mock APIs
    • Defining a mock API
    • Creating and querying database snapshots
  • Mock API reference
  • Fabricate API and CLI
    • About the Fabricate API and CLI
    • Managing Fabricate API keys
    • Daily limits on generated data
    • Using the Fabricate API
      • Authentication for the API
      • Data model
      • Managing databases from the API
      • Generating data from the API
    • Using the Fabricate CLI
      • Setting up CLI access
      • Using the CLI to load data
Powered by GitBook
On this page
  • Installing the CLI
  • Install with npm
  • Install with yarn
  • Configuring an API key
  • Allowlisting the Fabricate IP address
Export as PDF
  1. Fabricate API and CLI
  2. Using the Fabricate CLI

Setting up CLI access

Last updated 8 days ago

Installing the CLI

To install the CLI, you can either use npm or yarn.

Install with npm

To use npm:

npm i -D @fabricate/cli

Install with yarn

To use yarn:

yarn install -dev @fabricate/cli

Configuring an API key

Before you can use the CLI, you must define an environment variable called FABRICATE_API_KEY that contains a valid .

Allowlisting the Fabricate IP address

To allow Fabricate to connect directly to your database, allow access from the following IP addresses:

  • 5.161.104.100

Fabricate API key