1.0.1 โ€ข Published 11 months ago

@boltic/cli v1.0.1

Weekly downloads
-
License
ISC
Repository
-
Last release
11 months ago

โšก Boltic CLI

A powerful CLI tool for creating, managing, and publishing Boltic integrations.

NPM Version License Node Version


๐Ÿ“ฆ Installation

Install Boltic CLI globally via NPM:

npm install -g @boltic/cli

๐Ÿ” Authentication

To log in:

boltic login

Follow the interactive prompt to enter your credentials. Your token will be stored securely for future use.


๐Ÿงฉ Integration Management

โž• Create a New Integration

boltic integration create

Youโ€™ll be prompted to enter:

  • Name: Letters and underscores only (e.g., My_Integration)
  • Icon: Select an SVG file from your computer
  • Integration Type:

    • Workflow Activity: Reusable components that perform specific tasks
    • Workflow Trigger: Components that start your workflow based on external events
    • You can choose to create both types for the same integration
  • Descriptions

    • Human-readable and AI-generated
  • Integration Group

    • e.g., Analytics, CRM, ERP, Marketing, Payment, Social Media, Other

โœ๏ธ Edit an Integration

boltic integration edit

๐Ÿ”„ Sync an Integration

boltic integration sync

๐Ÿš€ Publish an Integration

boltic integration publish

๐Ÿ“Œ Command Reference

CommandDescription
boltic loginAuthenticate with Boltic
boltic integration createCreate a new integration
boltic integration syncSync changes to your draft
boltic integration publishSubmit integration for review
boltic integration pullPull the latest changes of an integration from the Cloud
boltic integration editEdit an existing integration
boltic helpShow CLI help
boltic versionDisplay CLI version

๐Ÿ” Typical Workflow

# Step 1: Authenticate
boltic login

# Step 2: Start a new integration
boltic integration create

# Step 3: Save changes
boltic integration sync

# Step 5: Submit for publishing and review
boltic integration publish

# Step 6: Pull the latest changes of a integration. Please call this command inside a integration folder.
boltic integration pull

# Step 7: Use this command if you don't have folder of a particular integration. Please call this command outside of any existing integration folder.
boltic integration edit

๐Ÿ› ๏ธ Troubleshooting

Login Errors

  • Make sure you're online and using valid credentials.
  • Retry boltic login if your token has expired.

Integration Issues

  • Ensure all required fields (e.g., name, type, icon URL) are filled.
  • Verify the icon URL is publicly accessible.
  • Double-check the selected integration type and group.

๐Ÿ“š Help

Get help directly in the CLI:

# View all commands
boltic help

# View integration command options
boltic integration help

Or visit the Boltic Docs for full documentation.


๐Ÿงพ License

MIT ยฉ Boltic