Skip to content

github ​

The github command lets you query GitHub repository information directly without AI interpretation. It provides raw access to repository data including workflows, pull requests, runners, and workflow runs.

Usage ​

bash
clanker github <subcommand> [flags]

Subcommands ​

github list ​

List GitHub resources of a specific type. The resource type is a required positional argument.

bash
clanker github list <resource> [flags]

Supported Resources ​

ResourceAliasesDescription
reposrepositoriesAccessible GitHub repositories
runnersrunnerRepository self-hosted runners
workflowsworkflowGitHub Actions workflows
runsrunRecent workflow runs
prspr, pullrequests, pull-requestsRecent pull requests

Flags ​

FlagShortTypeDefaultDescription
--repo-rstringFrom configRepository in owner/repo format. Overrides the default repository from configuration

Examples:

bash
# List all accessible repositories
clanker github list repos

# List GitHub Actions workflows for a specific repo
clanker github list workflows -r myorg/myrepo

# List recent workflow runs
clanker github list runs -r myorg/myrepo

# List recent pull requests
clanker github list prs -r myorg/myrepo

# List self-hosted runners
clanker github list runners -r myorg/myrepo

TIP

The repos resource does not require the --repo flag, as it lists all repositories accessible to your configured token. All other resources require either the --repo flag or a default_repo set in your clanker configuration.


github status ​

Show GitHub authentication status or the status of a specific GitHub Actions workflow. When called without arguments, it displays general authentication and repository status. When a workflow name is provided, it shows the status of that specific workflow.

bash
clanker github status [workflow-name] [flags]

Flags ​

FlagShortTypeDefaultDescription
--repo-rstringFrom configRepository in owner/repo format. Overrides the default repository from configuration

Examples:

bash
# Show general GitHub authentication status
clanker github status

# Show status of a specific workflow
clanker github status "CI Pipeline" -r myorg/myrepo

# Check workflow status on a specific repository
clanker github status deploy -r myorg/backend

Authentication ​

The github command uses a personal access token configured in your ~/.clanker.yaml file under github.token. The token can also be left empty for public repository access.

yaml
github:
  token: "ghp_xxxxxxxxxxxxxxxxxxxx"
  default_repo: myorg/myrepo
  repos:
    - owner: myorg
      repo: myrepo
      description: Main application repository

Repository Resolution ​

When the --repo flag is not specified, clanker resolves the repository in the following order:

  1. The default_repo value from ~/.clanker.yaml
  2. The repository list configured under github.repos
  3. The current Git remote (if available)

See Also ​

  • Configuration -- Setting up GitHub token and repositories
  • ask -- Querying GitHub with natural language through the AI pipeline