codebolt-provider-development

Implement CodeBolt provider hooks for remote executor environments.

1|Updated Apr 24, 2024
One-click install
npx skills add https://github.com/codeboltai/codeboltjs --skill codebolt-provider-development
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: codebolt-provider-development
Source: https://github.com/codeboltai/codeboltjs/tree/main/.agent/skills/codebolt-provider-development
Command: npx skills add https://github.com/codeboltai/codeboltjs --skill codebolt-provider-development

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

CodeBolt providers enable developers to connect applications to external environments running remote executors. They solve the challenge of bridging application logic with external environments, handling provision, deployment, communication, and lifecycle management.

Core Features & Use Cases

  • Environment provisioning: Create and configure external environments (local, Docker, SSH, or cloud) to host remote executors.
  • Remote executor lifecycle: Start, monitor, and manage the agent server inside the environment, including health checks and heartbeats.
  • Provider integration: Implement required hooks (setupEnvironment, resolveProjectContext, onGetDiffFiles, teardownEnvironment) and wire file operations for cross-environment workflows.
  • Use Case: Build a Docker-based provider that spins up a container per environment, mounts the project, and exposes an agent server for the CodeBolt app to connect to.

Quick Start

Start from the provider template, implement the required environment setup steps, wire file operations, and integrate with CodeBolt's event system to enable remote execution.

Frequently Asked Questions about codebolt-provider-development

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I build a CodeBolt provider for a Docker remote environment?

To build a CodeBolt provider for a Docker remote environment, you implement lifecycle and environment management hooks like setupEnvironment, resolveProjectContext, and teardownEnvironment, wiring file operations to spin up containers and expose an agent server.

What are the required hooks for implementing a CodeBolt provider?

The required hooks for implementing a CodeBolt provider are setupEnvironment, resolveProjectContext, onGetDiffFiles, and teardownEnvironment. You must wire these alongside CodeBolt event handlers to enable end-to-end remote execution.

How does remote executor lifecycle management work with CodeBolt providers?

Remote executor lifecycle management with CodeBolt providers works by starting, monitoring, and managing the agent server inside the external environment, utilizing health checks and heartbeats to ensure cross-environment workflows remain connected.

Can I connect an SSH-based remote executor to my application using a CodeBolt provider?

Yes, you can connect an SSH-based remote executor to your application. CodeBolt providers support provisioning external environments like local, Docker, SSH, or cloud setups to host the agent server and bridge application logic.

What is the best way to handle environment provisioning for remote execution?

The best way to handle environment provisioning for remote execution is to implement the setupEnvironment hook within your CodeBolt provider, configuring the external environment to host the remote executor and expose necessary communication channels.

Why do I need to wire file operations when developing a CodeBolt provider?

You need to wire file operations when developing a CodeBolt provider to integrate with CodeBolt's event system, enabling cross-environment workflows by syncing project contexts and managing diff files between the application and remote executor.