signaloid-cli github proxy

Proxy a GitHub API request via Signaloid.

Synopsis

signaloid-cli github proxy --path <path> [options]

Description

Proxies a GitHub API request through Signaloid using your connected GitHub integration. This allows you to make authenticated GitHub API calls without directly managing tokens.

Options

Option	Description
--path <path>	GitHub API path (e.g., 'user/repos', 'repos/owner/name') (required)
--method <m>	HTTP method: GET, POST, PUT, DELETE (default: GET)

GitHub API Paths

Common GitHub API paths:

• user - Current user information
• user/repos - User's repositories
• repos/{owner}/{repo} - Repository details
• repos/{owner}/{repo}/branches - Repository branches
• repos/{owner}/{repo}/commits - Repository commits

See GitHub API Documentation for all available endpoints.

Output

Returns the GitHub API response in JSON format.

Examples

Get User Information

signaloid-cli github proxy --path user

List User Repositories

signaloid-cli github proxy --path user/repos

Get Repository Details

signaloid-cli github proxy --path repos/owner/repository

List Branches

signaloid-cli github proxy --path repos/owner/repository/branches

Get Commit History

signaloid-cli github proxy --path repos/owner/repository/commits

List Repository Issues

signaloid-cli github proxy --path repos/owner/repository/issues

Advanced Queries

# Get repository contributors
signaloid-cli github proxy --path repos/owner/repository/contributors

# Get repository languages
signaloid-cli github proxy --path repos/owner/repository/languages

# Get repository tags
signaloid-cli github proxy --path repos/owner/repository/tags

# Get specific commit
signaloid-cli github proxy --path repos/owner/repository/commits/abc123

Extract Specific Data

# Get repository clone URL
signaloid-cli github proxy --path repos/owner/repository | \
  jq -r '.clone_url'

# List branch names
signaloid-cli github proxy --path repos/owner/repository/branches | \
  jq -r '.[].name'

# Get default branch
signaloid-cli github proxy --path repos/owner/repository | \
  jq -r '.default_branch'

# Count stars
signaloid-cli github proxy --path repos/owner/repository | \
  jq '.stargazers_count'

Using POST Method

# Note: POST, PUT, DELETE may require additional permissions
# and request body handling

# Example placeholder - actual implementation may vary
signaloid-cli github proxy \
  --path repos/owner/repository/issues \
  --method POST

Exit Codes

Code	Description
0	Success
1	Proxy request failed (invalid path, insufficient permissions, API error)

Notes

• Requires active GitHub integration (use github connect first)
• API rate limits apply based on your GitHub account
• Some endpoints may require additional token scopes
• The path should not include https://api.github.com - just the path component

Rate Limiting

GitHub API has rate limits:

• Authenticated requests: 5,000 per hour
• Unauthenticated requests: 60 per hour

Check rate limit status:

signaloid-cli github proxy --path rate_limit

Common API Paths Reference

Path	Description
user	Current user profile
user/repos	User's repositories
orgs/{org}	Organization details
orgs/{org}/repos	Organization repositories
repos/{owner}/{repo}	Repository details
repos/{owner}/{repo}/branches	Repository branches
repos/{owner}/{repo}/commits	Commit history
repos/{owner}/{repo}/contents/{path}	File contents
repos/{owner}/{repo}/issues	Repository issues
repos/{owner}/{repo}/pulls	Pull requests

See Also

• signaloid-cli github repos - List repositories (convenience command)
• signaloid-cli github branches - List branches (convenience command)
• signaloid-cli github connect - Connect GitHub
• GitHub API Documentation - Complete API reference