Installation & Setup

This guide will walk you through setting up CodeInput for your GitHub repositories.

Prerequisites

Before you begin, ensure you have:

• A GitHub account with admin access to the repositories you want to integrate
• Node.js 18+ (for local development integrations)
• Git installed on your local machine

Installation Steps

1. Create Your CodeInput Account

1. Visit codeinput.com
2. Click "Sign Up" and authenticate with your GitHub account
3. Choose your subscription plan (free tier available)

2. Install the GitHub App

CodeInput uses a GitHub App to access your repositories safely and securely.

1. Navigate to the Integrations page in your CodeInput dashboard
2. Click "Install GitHub App"
3. Select the repositories you want to integrate:
   • All repositories (recommended for organizations)
   • Selected repositories (for specific projects)
4. Review and accept the required permissions

Required Permissions

The CodeInput GitHub App requests these permissions:

• Repository contents: Read/write access to resolve conflicts
• Pull requests: Create and modify PRs for conflict resolution
• Issues: Create issues for tracking conflicts
• Metadata: Basic repository information
• Checks: Run status checks on PRs

3. Configure Repository Settings

For each connected repository:

1. Go to Repository Settings in your CodeInput dashboard
2. Configure your preferences:
   • Auto-merge settings: When to automatically merge PRs
   • Conflict resolution strategy: AI assistance level
   • Team notifications: How your team gets notified
   • CODEOWNERS integration: Enable advanced ownership features

4. Set Up Team Access

If you're working with a team:

1. Navigate to Team Management
2. Invite team members by email
3. Assign roles:
   • Admin: Full repository configuration access
   • Developer: Can resolve conflicts and create PRs
   • Viewer: Read-only access to analytics

5. Configure Webhook Settings (Optional)

For advanced integrations, you can configure custom webhooks:

# Example webhook endpoint
POST https://your-domain.com/webhooks/codeinput

Webhook events available:

• conflict.detected
• conflict.resolved
• merge.completed
• review.requested

Local Development Setup

If you're integrating CodeInput with your local development workflow, you can use the GitHub App integration and web interface to manage your repositories directly from your browser.

Verification

To verify your installation:

1. Create a test branch with a small change
2. Create a conflicting change on another branch
3. Open a pull request
4. Check that CodeInput detects and offers to resolve the conflict

Common Issues

GitHub App Not Appearing

• Ensure you have admin access to the repository
• Check that the GitHub App installation wasn't revoked
• Verify your organization's third-party app policies

Permissions Errors

• Review the GitHub App permissions in your repository settings
• Ensure CodeInput has access to the specific repositories you're trying to use
• Check your organization's security settings

Webhook Failures

• Verify your webhook URL is accessible from GitHub
• Check that your endpoint accepts POST requests
• Review webhook delivery logs in GitHub settings