Skip to content

usage.md

Latest commit

 

History

History
397 lines (300 loc) · 6.3 KB

usage.md

File metadata and controls

397 lines (300 loc) · 6.3 KB

GitCo Usage Guide

This guide provides comprehensive usage examples and workflows for GitCo, covering all major features and common use cases.

Table of Contents

  1. Basic Workflows
  2. Repository Management
  3. Analysis and Discovery
  4. Health Monitoring
  5. Contribution Tracking
  6. Backup and Recovery
  7. Automation
  8. Advanced Workflows

Basic Workflows

Daily Repository Sync

Sync all repositories:

gitco sync

Sync specific repository:

gitco sync --repo django

Sync with analysis:

gitco sync --analyze

Batch sync with export:

gitco sync --batch --export sync-report.json

Repository Health Check

Check all repositories:

gitco status

Detailed health report:

gitco status --detailed

Filter by health status:

gitco status --filter healthy
gitco status --filter needs_attention
gitco status --filter critical

Activity Monitoring

View activity dashboard:

gitco activity

Detailed activity metrics:

gitco activity --detailed

Activity for specific repository:

gitco activity --repo django --detailed

Repository Management

Repository Validation

Validate repository structure:

gitco validate-repo --repo django

Validate all repositories:

gitco validate-repo --all

Detailed validation report:

gitco validate-repo --repo django --detailed --export validation.json

Upstream Management

Add upstream remote:

gitco upstream add --repo django --url https://github.com/django/django.git

Verify upstream configuration:

gitco upstream validate --repo django

Update upstream URL:

gitco upstream update --repo django --url https://github.com/new-org/django.git

Remove upstream remote:

gitco upstream remove --repo django

Analysis and Discovery

Change Analysis

Analyze repository changes:

gitco analyze --repo django

Analyze with custom prompt:

gitco analyze --repo django --prompt "Focus on security implications"

Analyze multiple repositories:

gitco analyze --repos "django,fastapi"

Get detailed analysis:

gitco analyze --repo django --detailed

Contribution Discovery

Discover all opportunities:

gitco discover

Filter by skill:

gitco discover --skill python
gitco discover --skill javascript

Filter by label:

gitco discover --label "good first issue"
gitco discover --label "bug"

Set confidence threshold:

gitco discover --min-confidence 0.5

Personalized recommendations:

gitco discover --personalized --show-history

Export discovery results:

gitco discover --export opportunities.json

Health Monitoring

Repository Health

Basic health check:

gitco status

Sort by metrics:

gitco status --sort health
gitco status --sort activity
gitco status --sort stars

Export health data:

gitco status --export health.json

Activity Monitoring

Filter by activity level:

gitco activity --filter high
gitco activity --filter moderate
gitco activity --filter low

Sort by activity metrics:

gitco activity --sort activity
gitco activity --sort engagement

Export activity data:

gitco activity --export activity.json

Contribution Tracking

Sync Contribution History

Sync your contribution history:

gitco contributions sync-history --username yourusername

View contribution stats:

gitco contributions stats

Get recommendations:

gitco contributions recommendations

Trending analysis:

gitco contributions trending --days 30 --export skill-trends.json

Backup and Recovery

Create Backups

Create full backup:

gitco backup create --type full --description "Weekly backup"

Create incremental backup:

gitco backup create --type incremental --description "Daily backup"

List backups:

gitco backup list

Restore from backup:

gitco backup restore --backup-id backup-id

Automation

Quiet Mode

Quiet sync for automation:

gitco --quiet sync --batch

Export for monitoring:

gitco status --export status.json --output-format json

GitHub Actions

name: GitCo Sync
on:
  schedule:
    - cron: '0 2 * * *'  # Daily at 2 AM

jobs:
  sync:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - name: Install GitCo
        run: pip install gitco
      - name: Sync repositories
        run: |
          export GITHUB_TOKEN=${{ secrets.GITHUB_TOKEN }}
          export OPENAI_API_KEY=${{ secrets.OPENAI_API_KEY }}
          gitco --quiet sync --batch --export sync-report.json

Advanced Workflows

Multi-Repository Analysis

Analyze multiple repositories:

gitco analyze --repos "django,fastapi,flask" --detailed --export analysis.json

Batch discovery across repositories:

gitco discover --repos "django,fastapi" --skill python --export opportunities.json

Performance Monitoring

Check performance metrics:

gitco performance --detailed

Export performance data:

gitco performance --export performance.json

GitHub Integration

Check rate limits:

gitco github rate-limit-status

Get repository info:

gitco github get-repo --repo django/django

Get issues from multiple repos:

gitco github get-issues-multi --repos "django/django,fastapi/fastapi"

Troubleshooting

Common Issues

Validate configuration:

gitco config validate

Check GitHub connection:

gitco github connection-status

Check rate limits:

gitco github rate-limit-status

Debug mode:

gitco --debug sync

Get Help

Comprehensive help:

gitco help

Command-specific help:

gitco sync --help
gitco analyze --help
gitco discover --help