Back to Home
DOCUMENTATION

Documentation

Complete guide to integrating Covalynce into your workflow

Quick Start Guide

1Install & Authenticate

# Install Covalynce CLI
npm install -g @covalynce/cli
# Or using yarn
yarn global add @covalynce/cli
# Authenticate
covalynce auth

This will open your browser and authenticate via GitHub OAuth. You'll need a GitHub account with access to the repositories you want to connect.

2Connect Your Repository

# Link your repo
covalynce link --repo your-org/your-repo
# Or link multiple repos
covalynce link --repo org/repo1 org/repo2

Covalynce will automatically detect PRs, commits, and releases. The webhook is configured automatically when you link a repository.

3Configure Project Management Tools

# Connect Jira
covalynce integrations connect jira
# Connect Linear
covalynce integrations connect linear

Connect your project management tools to enable sprint retrospectives and roadmap updates. Covalynce will automatically sync sprint completions and ticket resolutions.

4Set Up Content Channels

# Connect Twitter
covalynce channels add twitter
# Connect LinkedIn
covalynce channels add linkedin
# Connect Slack (for notifications)
covalynce channels add slack

Connect your social media accounts and communication channels. Content will be auto-generated and queued for approval. Pro plans support auto-posting.

5Test Your First Generation

# Generate content for latest PR
covalynce generate --pr latest
# Or generate for a specific PR
covalynce generate --pr 123
# Review and approve
covalynce approve --id <generation-id>
# Or reject
covalynce reject --id <generation-id>

Review the generated content in your dashboard or via CLI. Approve to post (or auto-post on Pro plans), or reject to discard.

How It Works

Covalynce operates as an event-driven orchestration layer between your engineering workflow and your marketing channels. The platform follows a three-stage pipeline: Ingest → Process → Broadcast.

Stage 1: Ingest

Real-time webhooks capture events from GitHub (PR merges, releases), Jira (sprint completions), Linear (cycle closures), and Intercom (support tickets). Events are queued instantly with zero latency.

Stage 2: Process

LLM (OpenAI GPT-4 or Anthropic Claude) analyzes code diffs, commit messages, and ticket metadata. The system distinguishes between chore, fix, and feature changes. Context is extracted ephemerally—your code never touches disk.

Stage 3: Broadcast

Generated content is queued for approval. On approval (or auto-approval for Pro plans), content is distributed to Twitter, LinkedIn, Slack, Notion, and other connected channels in under 200ms. Each channel receives platform-optimized formatting.

Zero Storage: All processing happens in ephemeral memory. Your code is never stored, only analyzed in real-time. Generated content drafts are stored until you delete them.

Core Modules

Engineering Module

MODULE_01

The "Silent Manager" automatically drafts your weekly engineering updates by analyzing every PR merged that week. Filters out chore and fix PRs, focusing on meaningful features and improvements.

> Detecting 12 Merged PRs...
> Filtering out 'chore' & 'fix'...
✓ Draft Created: "Weekly Ship Report"

Product Module

MODULE_02

Automated Sprint Hygiene watches Jira and Linear. When a sprint ends, we auto-draft the Retrospective document in Notion and update the public roadmap with completed features.

> Sprint 42 Ended
✓ Notion Page Created: "Retro 42"

Growth Module

MODULE_03

The Customer Loop turns Intercom tickets into Jira Issues. Detects high-volume complaints (e.g., "Login Bug") and auto-escalates directly to Engineering with P0 priority.

> Alert: 50x "Login Error" in Intercom
✓ Jira Ticket Created: P0 Critical

Advanced Configuration

Custom Templates

Create custom content templates for different types of changes. Templates support Handlebars-style variables:

# .covalynce/templates/twitter.md
🚀 Feature: {{title}} is now live!
Impact: {{impact}}
Try it: {{url}}
Tags: {{tags}}

Available variables: title, impact, url, author, pr_number, tags

Workflow Rules

Define rules for when content should be generated. Rules support complex conditions:

# .covalynce/rules.yaml
rules:
- trigger: pr.merged
when:
labels includes "feature"
files_changed > 5
channels: [twitter, linkedin]
template: feature-release
- trigger: sprint.closed
channels: [notion, slack]

Rules are evaluated in order. First matching rule wins.

Content Filters

Configure what types of changes should generate content:

# .covalynce/config.yaml
filters:
exclude_labels: ["chore", "docs", "refactor"]
min_files_changed: 3
require_reviewers: true

Pricing & Limits

Hacker (Free)

  • • 3 generations per month
  • • Manual approval only
  • • 1 repository connected
  • • Basic templates

Starter ($9/mo)

  • • 20 generations per month
  • • Auto-posting enabled
  • • 3 repositories connected
  • • Custom templates
  • • Workflow rules

Pro ($29/mo)

  • • Unlimited generations
  • • Slack integration
  • • Unlimited repositories
  • • Priority support
  • • Advanced analytics