Configuration
Development Environment
After downloading the CLI, you will need to configure your development environment with your credentials.
You will need:
-
SaaS (app.import.io) API Key. Which can be found at https://app.import.io/dash/account/settings
-
Workbench User Token. Instructions for getting your User Token are here.
Once you have both of the above, run the following command:
import-io config
After you’ve pasted each key you are good to go.
Debugging
The Extractor Studio CLI allows you to debug and step through your code. To do so simply:
-
Add the word
debugger
to your code where you want the execution to pause -
Add
DEBUGGER=true
before yourextractor:run:local
,extractor:run:remote
,action:run:local
, oraction:run:remote
command -
Attach your debugger
Org Configuration
In an Extractor Library built by Extractor Studio, Extractor developers are able to build, deploy, and maintain Extractors for multiple Organizations inside Workbench.
Each Organization contains a directory under src/orgs/
, and in the root directory lives a config.yaml
file.
This configuration file aids the CLI when deploying and interacting with assets on Workbench, and allows developers to explicitly define which resources are maintained by the library. Additionally, this file allows developers to give aliases to Collections, to help make development and deployment commands easier.
An Org config.yaml
file contains the following properties:
-
collections
-
An object which itemizes the Organization’s Collections maintained by the Library
-
Keys are slugs or user defined shorthands for collections
-
Values are Collection Id’s, can be retrieved from the Collection Home page in Workbench
-
-
legacyAccountId
-
ID for Organization’s corresponding app.import.io account
-
Deprecated This field will be removed in a future version of Extractor Studio.
-