bp read

Read and parse integration definitions

Read and display the structure of an integration definition file.

Usage

bp read

What it does

The read command:

1. Locates integration definition
2. Parses the integration.definition.ts file
3. Validates the schema
4. Displays structured output

Options

—workDir

Specify integration directory:

bp read --workDir ./my-integration

Default: current directory

Global options

All global options are available:

bp read --verbose
bp read --json

Output

Displays integration structure:

• Name and version
• Description
• Actions
• Events
• Channels
• States
• Configuration schema
• User tags
• Secrets

JSON output

Use --json for machine-readable output:

bp read --json > integration.json

Examples

Read current integration

cd my-integration
bp read

Read specific integration

bp read --workDir ./integrations/teams

Export to JSON

bp read --json > definition.json

Verbose output

bp read --verbose

Use cases

Verify integration structure

Quickly check your integration definition:

bp read

Debug integration issues

Use verbose mode to see parsing details:

bp read --verbose

Integration documentation

Export definition for documentation:

bp read --json > docs/integration-schema.json

CI/CD validation

Validate definition in pipeline:

bp read --json || exit 1

Integration definition

The command reads from:

integration.definition.ts

Example definition:

import { IntegrationDefinition } from '@botpress/sdk'

export default new IntegrationDefinition({
  name: 'my-integration',
  version: '0.1.0',
  actions: {
    sendMessage: {
      title: 'Send Message',
      input: {
        schema: z.object({
          text: z.string()
        })
      },
      output: {
        schema: z.object({
          messageId: z.string()
        })
      }
    }
  },
  events: {
    messageReceived: {
      schema: z.object({
        text: z.string(),
        userId: z.string()
      })
    }
  }
})

Related commands

• bp lint - Lint integration definition (experimental)
• bp generate - Generate types from definition
• bp build - Build integration for deployment