Command line interface for developing, deploying, and managing Flatfile Agents
.env
file) or as command flags. You can find your API key and Environment ID in your Flatfile dashboard under “API Keys and Secrets”.
.env
file in your project root for secure,
convenient, and consistent authentication. If you’re using Git, make sure to
add .env
to your .gitignore
file..env
file
Create a .env
file in your project root:
Region | API URL |
---|---|
US | platform.flatfile.com/api |
UK | platform.uk.flatfile.com/api |
EU | platform.eu.flatfile.com/api |
AU | platform.au.flatfile.com/api |
CA | platform.ca.flatfile.com/api |
.env
:
Develop Locally
develop
to run your listener locally with live reloadingDeploy to Production
deploy
to push your listener to Flatfile’s cloud as an AgentManage Agents
agents
commands to list, download, or delete deployed agentsOption | Description |
---|---|
[file-path] | Path to listener file (auto-detects if not provided) |
--token | Flatfile API key |
--env | Environment ID |
Option | Description |
---|---|
[file-path] | Path to listener file (auto-detects if not provided) |
--slug , -s | Unique identifier for the agent |
--ci | Disable interactive prompts for CI/CD |
--token | Flatfile API key |
--env | Environment ID |
./index.js
./index.ts
./src/index.js
./src/index.ts
default
.agents list
to find the agent slug you need.Option | Description |
---|---|
--agentId , -ag | Use agent ID instead of slug |