StackOne CLI — Connector Development

Important

1. Fetch

   https://docs.stackone.com/guides/connector-engine/cli-reference

   for the current command reference
2. Fetch

   https://www.npmjs.com/package/@stackone/cli

   for the latest version

Instructions

Step 1: Install the CLI

npm install -g @stackone/cli

stackone

stackone --version

Step 2: Understand when to build a custom connector

• Check if the provider already exists: use the

  stackone-connectors

  skill or browse https://docs.stackone.com/connectors/introduction
• If the provider exists but is missing specific actions, you may not need a full custom connector — check the Actions RPC endpoint first

Step 3: Initialize a connector project

https://docs.stackone.com/guides/connector-engine/connector-structure

• Project scaffolding
• Local development server for testing
• Type-safe action definitions
• Deployment tooling

Step 4: Use the AI Builder (optional)

https://docs.stackone.com/guides/connector-engine/ai-builder

Step 5: Test locally

https://docs.stackone.com/guides/connector-engine/cli-reference

Step 6: Deploy

https://docs.stackone.com/guides/connector-engine/github-workflow

Examples

Example 1: User wants to build a connector for an internal API

1. Confirm the internal API has a REST/GraphQL endpoint
2. Install the CLI:

   npm install -g @stackone/cli

3. Fetch the connector structure guide for the scaffolding command
4. If they have an OpenAPI spec, suggest the AI Builder for faster scaffolding
5. Walk through the init → develop → test → deploy flow

Example 2: User wants to set up CI/CD for connector deployment

1. Fetch

   https://docs.stackone.com/guides/connector-engine/github-workflow

2. Walk through the GitHub Actions workflow configuration
3. Explain the deployment stages (dev → staging → production)

Troubleshooting

CLI command not found after install

• Run

  npm config get prefix

  to find the install location
• Add

  {prefix}/bin

  to your PATH
• Alternatively, use

  npx @stackone/cli

  instead of the global command

Authentication failures in CLI

• The CLI requires a StackOne API key
• Fetch the CLI reference for the current auth setup command
• Verify the key is active at https://app.stackone.com

Connector deployment fails

• Fetch the CLI reference for deployment troubleshooting
• Common issues: missing required fields in connector config, network timeouts
• For CI/CD failures, check that secrets are correctly configured in GitHub Actions