An open API service indexing awesome lists of open source software.

https://github.com/qbicsoftware/occo

Useful agents configuration for various daily tasks.
https://github.com/qbicsoftware/occo

Last synced: 3 months ago
JSON representation

Useful agents configuration for various daily tasks.

Awesome Lists containing this project

README

          

# Occo

[![License: AGPL-3.0](https://img.shields.io/badge/License-AGPL--3.0-blue.svg)](LICENSE)
[![Go Version](https://img.shields.io/github/go-mod/go-version/qbicsoftware/occo?logo=go)](https://github.com/qbicsoftware/occo/blob/main/go.mod)
[![Version](https://img.shields.io/github/v/release/qbicsoftware/occo?include_prereleases&label=version)](https://github.com/qbicsoftware/occo/releases)
[![CI](https://github.com/qbicsoftware/occo/actions/workflows/ci.yml/badge.svg)](https://github.com/qbicsoftware/occo/actions/workflows/ci.yml)
[![E2E CLI](https://github.com/qbicsoftware/occo/actions/workflows/e2e-cli.yml/badge.svg)](https://github.com/qbicsoftware/occo/actions/workflows/e2e-cli.yml)

**Manage OpenCode configuration bundles and schema-validated multi-agent workflows**

## CLI Demo

![CLI demo](docs/demo.gif)

Source tape: [docs/demo.tape](docs/demo.tape)
Repeatable capture steps: [docs/demo-playbook.md](docs/demo-playbook.md)

## What is this?

A CLI tool (`occo`) that manages OpenCode [configuration bundles](docs/config-bundles.md) from external sources, enabling versioned, validated configs for AI agents.

## Quick Start (30 seconds)

```sh
# Install via Go (macOS/Linux)
go install github.com/qbicsoftware/occo@latest

# Register a config bundle
occo source add qbicsoftware/opencode-config-bundle --name qbic

# Install a preset
occo bundle install qbic --preset mixed --project-root .
```

## Installation

Detailed installation guide: [docs/installation.md](docs/installation.md)

Install methods:
- `go install` (recommended)
- Manual download from GitHub Releases

## Shell Completion

Enable tab completion for your shell:

```sh
# Bash: source on the fly, or install permanently
source <(occo completion bash)
occo completion bash | sudo tee /etc/bash_completion.d/occo > /dev/null

# Zsh: source on the fly (recommended)
source <(occo completion zsh)

# Or save to completions dir:
# occo completion zsh > ~/.zsh/completions/_occo
# Add to ~/.zshrc: fpath=(~/.zsh/completions $fpath)
# Clear cache: rm -f ~/.zcompdump && exec zsh

# Fish
occo completion fish > ~/.config/fish/completions/occo.fish
```

Run `occo completion --help` for full instructions.

## Key Concepts

| Concept | Description |
|---------|-------------|
| **Sources** | Registered bundle repositories (GitHub releases) |
| **Bundles** | Versioned, schema-validated OpenCode configs |
| **Presets** | Named configurations (e.g., `mixed`, `openai`) |

## Available Bundles

- [qbicsoftware/opencode-config-bundle](https://github.com/qbicsoftware/opencode-config-bundle) — Official bundle with multiple presets

## Documentation

| Guide | Description |
|-------|-------------|
| [docs/README.md](docs/README.md) | User documentation hub |
| [docs/installation.md](docs/installation.md) | Install on macOS/Linux |
| [docs/config-bundles.md](docs/config-bundles.md) | Understand bundles + create your own |
| [docs/demo-playbook.md](docs/demo-playbook.md) | Repeatable terminal demo script for README recordings |
| [docs/cli-reference.md](docs/cli-reference.md) | Full command reference |
| [docs/troubleshooting.md](docs/troubleshooting.md) | FAQ and common issues |

## Legacy (Bash Version)

The original Bash-based helper is deprecated. Use the Go CLI (`occo`) instead.

Archive documentation: [docs/legacy/bash-helper.md](docs/legacy/bash-helper.md)

---

## License

AGPL-3.0 — see the [LICENSE](LICENSE) file for details.