opencode-workflow

🥈Silver

OpenCode Workflow is an AI automation skill that provides a universal setup with specialized agents, skills, commands, and plugins for any software project. It benefits operations teams by streamlining workflows and connecting to various tools and workflows.

197140Updated 2w ago

Intermediate30min to implementautomation

Saves ~240 min per use

Quick InstallView Source

git clone https://github.com/CloudAI-X/opencode-workflow.git

Works with:

Claude

Overview

About This Skill

How to Use

[{"step":"Define your project scope","action":"Replace [PROJECT_NAME], [PROGRAMMING_LANGUAGE], and other placeholders in the prompt template with your specific project details (e.g., 'AI Chatbot', 'TypeScript', 'Next.js').","tip":"Be as specific as possible about your tech stack (e.g., 'React 18', 'Node.js 20', 'PostgreSQL') to ensure the workflow is tailored to your needs."},{"step":"Generate the workflow","action":"Paste the customized prompt into your AI assistant (e.g., Claude, ChatGPT) and run it. The output will include a project structure, skills, commands, and plugins.","tip":"Use the `--dry-run` flag if your AI tool supports it to preview the workflow before generating files."},{"step":"Integrate with your tools","action":"Commit the generated `.opencode/` directory to your project repository. Configure environment variables (e.g., AWS credentials, GitHub tokens) in your CI/CD pipeline.","tip":"For GitHub projects, enable GitHub Actions and link it to your repo. For AWS, ensure your IAM roles have the necessary permissions."},{"step":"Test the workflow","action":"Run the commands in the generated workflow (e.g., `opencode:test`, `opencode:review --pr=123`) to validate the setup. Trigger events like PRs or commits to test automation.","tip":"Start with a small feature branch to avoid disrupting your main branch. Use the `opencode:init` command to regenerate the workflow if you need adjustments."},{"step":"Iterate and extend","action":"Add custom skills, commands, or plugins by editing the `.opencode/config.yaml` file or creating new files in `.opencode/skills/`, `.opencode/commands/`, or `.opencode/plugins/`.","tip":"Leverage the OpenCode community for pre-built skills (e.g., 'SonarQube Integration', 'Jira Automation') and modify them to fit your workflow."}]

Setup & Installation

Quick Install

No install command available. Check the GitHub repository for manual installation instructions.

Alternative Install (Git Clone)

git clone https://github.com/CloudAI-X/opencode-workflow

Requirements

Claude Code or compatible AI agent
Works with: Claude

Quick Start Guide

Install the Skill

Copy the install command above and run it in your terminal.

Open Your AI Agent

Launch Claude Code, Cursor, or your preferred AI coding agent.

Try It Out

Use the prompt template or examples below to test the skill.

Customize

Adapt the skill to your specific use case and workflow.

Usage Examples

Prompt Template

Set up a complete OpenCode Workflow for [PROJECT_NAME] in [PROGRAMMING_LANGUAGE]. Include: 1) A project structure with [FOLDER_STRUCTURE], 2) Essential skills like [SKILLS_LIST], 3) Commands for [COMMANDS_LIST], and 4) Plugins for [PLUGINS_LIST]. Ensure all components are configured for [DEVELOPMENT_ENVIRONMENT].

Example Output

### OpenCode Workflow Setup for 'E-Commerce API' (Python)

**Project Structure:**
```
ecommerce-api/
├── src/
│   ├── models/
│   ├── routes/
│   ├── services/
│   └── utils/
├── tests/
├── config/
├── docs/
└── .opencode/
    ├── skills/
    ├── commands/
    └── plugins/
```

**Essential Skills:**
- **Code Review Agent:** Auto-review PRs for Python best practices, security vulnerabilities, and performance bottlenecks.
- **Documentation Generator:** Creates API docs from docstrings and OpenAPI specs.
- **Test Automation:** Runs unit/integration tests on commit and generates coverage reports.
- **Dependency Manager:** Tracks and updates dependencies with security patches.

**Commands:**
- `opencode:init` → Initializes the workflow with pre-configured agents.
- `opencode:test` → Runs all tests and generates a JUnit report.
- `opencode:deploy --env=staging` → Deploys to staging with rollback support.
- `opencode:review --pr=123` → Reviews PR #123 and posts feedback in GitHub.

**Plugins:**
- **GitHub Integration:** Syncs workflows with GitHub Actions and PRs.
- **Docker Support:** Auto-generates Dockerfiles and docker-compose.yml.
- **AWS CLI:** Deploys to AWS ECS with IAM role validation.
- **Slack Notifier:** Posts deployment status and alerts to a team channel.

**Configuration:**
```yaml
# .opencode/config.yaml
project:
  name: ecommerce-api
  language: python
  version: 3.11
environments:
  staging:
    docker_image: ecommerce-api-staging:latest
    aws_ecr: 123456789012.dkr.ecr.us-west-2.amazonaws.com
    slack_channel: #dev-team-alerts
```

**Next Steps:**
1. Run `opencode:init` to generate the workflow files.
2. Commit the `.opencode/` directory to your repo.
3. Push a feature branch and open a PR to trigger the Code Review Agent.
4. Use `opencode:deploy --env=staging` to test the deployment pipeline.

All components are pre-configured for Python 3.11, Docker, AWS ECS, and GitHub. The workflow includes automated testing, security scanning, and deployment validation.