Skip to content

README.md

Latest commit

 

History

History
70 lines (49 loc) · 2.13 KB

README.md

File metadata and controls

70 lines (49 loc) · 2.13 KB
Raw

github-rest-cli

PyPI Python CI License: MIT

A Python CLI for common GitHub REST API operations—list and inspect repositories for a user or an organization, create, update, or delete them, manage Dependabot security settings, and manage deployment environments.

Installation

With pip:

pip install github-rest-cli

With uv:

uv pip install github-rest-cli

Requires Python 3.11.5 or newer.

Authentication

See Authentication for PAT scopes and how to set GITHUB_AUTH_TOKEN (or .secrets.toml).

For API URL overrides, settings files, and Dynaconf environments, see Configuration.

Quick start

github-rest-cli --version
github-rest-cli --help
github-rest-cli repo list
github-rest-cli repo get --name my-repo
github-rest-cli repo create --name my-new-repo --private
github-rest-cli repo create --name my-app --template owner/template-repo
github-rest-cli repo update --name my-repo --description "Updated"
github-rest-cli repo update --name my-repo --new-name renamed-repo
github-rest-cli repo update --name my-repo --as-template
github-rest-cli repo list --org my-org
github-rest-cli environment list --name my-repo
github-rest-cli environment get --name my-repo --env production

Commands

Full command reference: CLI guide.

github-rest-cli repo --help
github-rest-cli dependabot --help
github-rest-cli environment --help

Contributing

See CONTRIBUTING.md for local development, testing, linting, and Dynaconf tooling.

Links