Skip to main content
Develop Singer taps and targets.

hotglue singer validate

Validate a Singer file. It ensures that the data conforms to the expected schema and checks for any discrepancies or errors in the data records.

Sample

Options

  • --dataFilePath: The path to the data file that needs to be validated. Defaults to data.singer
  • --allowDuplicateRecords: A boolean flag to allow duplicate records in the data. Defaults to false. The key_properties field on SCHEMA messages is used to determine uniqueness for a stream.
  • --allowFuzzyTypes: A boolean flag to allow fields to allow multiple types for a field. Defaults to false.
  • --json: Outputs the validation result in JSON format.

hotglue singer create-tap

Scaffold a new Singer tap from the hotglue-tap-cookiecutter template. The generated project uses HotglueSingerSDK. The command uses cookiecutter. Cookiecutter must be installed and available on your PATH:
If cookiecutter is missing, the command exits with:

Sample

Interactive:

Non-interactive:

Pass -y or --yes to skip cookiecutter prompts and use the flags you provide. Omitted flags fall back to the template defaults.

Options

  • -y, --yes: Skip cookiecutter prompts and use the provided flags. Defaults to false.
  • --source-name: Source name in CamelCase (for example, Stripe).
  • --admin-name: Author full name.
  • --tap-id: Tap ID in kebab-case (for example, tap-stripe).
  • --library-name: Python package name in snake_case (for example, tap_stripe). If omitted and --tap-id is set, this is derived by replacing hyphens with underscores.
  • --stream-type: Stream type the source provides. One of REST, GraphQL, Other.
  • --stream-names: Comma-separated stream labels (for example, users,groups).
  • --api-base-url: API base URL used as url_base in client.py.
  • --auth-method: Authentication method for REST and GraphQL sources. One of API Key, Bearer Token, Basic Auth, OAuth2, JWT, Custom or N/A. For not interactive mode quote values that contain spaces.
  • --include-agent-instructions: Agent instructions file to include. One of AGENTS.md, CLAUDE.md, None.
  • --license: License for the generated project. One of MIT, Apache-2.0, None.

After scaffolding, see Running taps for local discover, stream selection, and sync.