Skip to content

Repository files navigation

GitHub Bot

Logo

LicensesLintingTestingSecurity AuditGitHub ReleaseLicense

A GitHub bot for your terminal.

Integrates ghk with custom commands, and plugins with built-in script.rs scripting.

Features

  • plugin infrastructure
    • built-in custom Rhai scripting
      • support for ruviz scientific graph plotting
        • High-performance 2D plotting library for Rust combining matplotlib's ease-of-use with Makie's performance
      • file system access
      • env.rs
        • automatically read .env, .env.$APP_ENV, and .env.local files
      • running shell commands
      • working with JSON, YAML, and TOML files
  • custom commands
    • maintain :: Maintain one or more repositories (cleanup, rerun, or release)
    • merge :: Merge Dependabot PRs for a specific repository
    • wip :: Work-in-progress commit helper
    • prune :: Prune local branches that don't exist remotely
  • ghk integration
CommandAliasPurposeRuns...
setupInstall requirements(Checks requirements)
initStart tracking foldergit init
login / logoutGitHub authgh auth login
createCreate repo on GitHubgh repo create
forkFork repo on GitHubgh repo fork
pushsaveSave changesgit add -A && git commit && git push
pullsyncDownload changesgit pull
clone <repo>downloadDownload repogh repo clone
statusShow statusgit status
diffPreview changesgit diff
historylogShow recent savesgit log
undoUndo last commitgit reset --soft HEAD~1
openOpen in browsergh browse
branchList/switch branchesgit branch
ignoreAdd .gitignore(Writes .gitignore)
licenseAdd license file(Writes LICENSE)
configView/edit settings(Edits config)
user list/switchManage accounts(Internal auth)
completionsShell completions(Generates script)

Help

GitHub automation botUsage: github-bot [OPTIONS] <COMMAND>Commands: maintain Maintain one or more repositories (cleanup, rerun, or release) merge Merge Dependabot PRs for a specific repository wip Work-in-progress commit helper. Push all uncommitted changes using the last commit prune Prune local branches that don't exist remotely git Simple GitHub helper. Push code without the complexity hello Ping test help Print this message or the help of the given subcommand(s)Options: -t, --token <TOKEN> Optional GitHub Personal Access Token (PAT) with 'repo' scope. If not provided, the program will look for the `GITHUB_TOKEN` environment variable -q, --quiet Suppress output (errors still shown) -v, --verbose... Increase logging verbosity -q, --quiet... Decrease logging verbosity --nocolor Disable colored output -h, --help Print help -V, --version Print version

Made with ❤️ and Rust

About

A GitHub bot for your terminal. Integratges GitHub client commands with plugins and built-in Rhai scripting.

Resources

Security policy

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Used by

Contributors

Languages