Skip to main content

Open CI pipelines from your current Git repository

Project description

ciopen

Python PyPI Build

Quickly open CI pipelines from your Git repository.

ciopen lets you open your CI pipelines or repository pages straight from the terminal โ€” works with GitHub, GitLab, Bitbucket, Azure DevOps (and more coming soon!).

Check out the docs:


โšก Features

Open CI pipeline on your default browser:

$ ciopen

๐Ÿ’ป Installation

Requirements:

  • Python >=3.10
  • Git installed and available in your PATH
  • Access to the Git remote of the repository you want to open

Using pip

$ pip install ciopen

Using pip (editable / dev mode)

$ git clone https://github.com/mel-cdn/ciopen.git
$ cd ciopen
$ pipenv shell        # or activate your virtualenv
$ ./run-checks.sh      # Install all dependencies

๐Ÿ› ๏ธ Usage Examples

Show helpful CLI documentation:

$ ciopen --help

 Usage: ciopen [OPTIONS] COMMAND [ARGS]...

 Quickly open CI pipelines from your Git repository.

 โ•ญโ”€ Options โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ•ฎ
 โ”‚ --install-completion          Install completion for the current shell                                        โ”‚
 โ”‚ --show-completion             Show completion for the current shell, to copy it or customize the installation.โ”‚
 โ”‚ --help                        Show this message and exit                                                      โ”‚
 โ•ฐโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ•ฏ
 โ•ญโ”€ Commands โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ•ฎ
 โ”‚ version   Show ciopen version                                                                                 โ”‚
 โ”‚ info      Show ciopen information                                                                             โ”‚
 โ”‚ doctor    Check if everything is set up right                                                                 โ”‚
 โ”‚ provider  Show which CI provider is detected                                                                  โ”‚
 โ”‚ repo      Open the main page of this repository                                                               โ”‚
 โ”‚ pr        Open the pull requests page of this repository                                                      โ”‚
 โ•ฐโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ•ฏ

Open your repository's main page:

$ ciopen repo

 Opening https://github.com/mel-cdn/ciopen

Check if it's going to work with diagnostics:

$ ciopen doctor

 ciopen 0.0.5
 Running diagnostics...

  โœ… Git installed
  โœ… Inside a Git repository
  โœ… Remote origin found
  โœ… CI Provider detected

 Environment details:

 Provider                : GitHub
 Repository slug         : mel-cdn/ciopen
 Current branch          : main
 Repository URL          : https://github.com/mel-cdn/ciopen
 Pipeline URL            : https://github.com/mel-cdn/ciopen/actions
 Pull Request URL        : https://github.com/mel-cdn/ciopen/pulls

๐Ÿ’ก Notes

  • Works with HTTPS and SSH Git remotes.
  • Detects CI provider automatically.
  • Can be extended with more CI providers easily.
  • Designed for casual, fast CLI usage.

๐Ÿ”ฎ Future Plans

  • Add support for custom CI/CD providers e.g. CircleCI, Jenkins, AWS CodeBuild, etc.
  • JSON output for scripts and automation
  • Auto-detect Git branch and multiple pipelines
  • Additional CLI shortcuts for common CI/CD tasks

๐Ÿค Contributing

ciopen is open for contributions!

All contributions are welcome โ€” whether itโ€™s new features, bug fixes, or improving docs.

  1. Clone the repository: git clone https://github.com/mel-cdn/ciopen.git
  2. Create a new branch: git checkout -b my-new-feature
  3. Install dependencies: ./run-checks.sh
  4. Make your changes
  5. Submit a pull request

Made with โค๏ธ for developers who love fast, terminal-first CI access.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ciopen-0.1.0.tar.gz (9.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

ciopen-0.1.0-py3-none-any.whl (12.2 kB view details)

Uploaded Python 3

File details

Details for the file ciopen-0.1.0.tar.gz.

File metadata

  • Download URL: ciopen-0.1.0.tar.gz
  • Upload date:
  • Size: 9.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.14

File hashes

Hashes for ciopen-0.1.0.tar.gz
Algorithm Hash digest
SHA256 7c7c5483b5039fd8501033153b9a7f2ba2d6ff5b23fe6c60ec42ba5bcb6203d3
MD5 3d6006239c80cddb8c95fa50f0eeae5b
BLAKE2b-256 42801d21d46c786706e5bbd01f4054fc7fd8bed2f09f3d032e5d37f8c6d860ef

See more details on using hashes here.

File details

Details for the file ciopen-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: ciopen-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 12.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.14

File hashes

Hashes for ciopen-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 e34416c7ca9b8a68c20d07ff5c98ed77b8b83913a0eef30a50e60f4f815927b2
MD5 3b97e02069354149f39d19b4377a8e42
BLAKE2b-256 d61c4c44356504b543b0e995e2bae1bf4b51981e53959b4458212df59b2dde21

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page