{"id":26075894,"url":"https://github.com/kabooboo/giphon","last_synced_at":"2025-04-11T21:13:05.933Z","repository":{"id":63613571,"uuid":"564259399","full_name":"kabooboo/giphon","owner":"kabooboo","description":"🦅 Download all projects in a Gitlab group or instance","archived":false,"fork":false,"pushed_at":"2025-03-20T10:39:09.000Z","size":495,"stargazers_count":10,"open_issues_count":1,"forks_count":2,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-11T21:12:59.949Z","etag":null,"topics":["cli","clone","gitlab","groups","projects"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/kabooboo.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null}},"created_at":"2022-11-10T10:37:09.000Z","updated_at":"2025-02-17T10:08:27.000Z","dependencies_parsed_at":"2023-11-06T11:39:56.854Z","dependency_job_id":"37ab303e-f345-4651-b9eb-abe1dcc80c61","html_url":"https://github.com/kabooboo/giphon","commit_stats":{"total_commits":11,"total_committers":1,"mean_commits":11.0,"dds":0.0,"last_synced_commit":"9b0fa0eb3bff909b1c7f8f53295fa95ba64522e5"},"previous_names":[],"tags_count":7,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kabooboo%2Fgiphon","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kabooboo%2Fgiphon/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kabooboo%2Fgiphon/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kabooboo%2Fgiphon/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/kabooboo","download_url":"https://codeload.github.com/kabooboo/giphon/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248480430,"owners_count":21110937,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cli","clone","gitlab","groups","projects"],"created_at":"2025-03-09T01:29:08.501Z","updated_at":"2025-04-11T21:13:05.893Z","avatar_url":"https://github.com/kabooboo.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"![Logo](docs/assets/logo.png)\n![PyPI - Python Version](https://img.shields.io/pypi/pyversions/giphon) [![Black](https://img.shields.io/badge/code%20style-black-black.svg)](https://pypi.org/project/black/) ![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/kabooboo/giphon/test.yml?label=tests)\n[![Hatch project](https://img.shields.io/badge/%F0%9F%A5%9A-Hatch-4051b5.svg)](https://github.com/pypa/hatch) ![PyPI](https://img.shields.io/pypi/v/giphon) ![PyPI - License](https://img.shields.io/pypi/l/giphon) ![GitHub Repo stars](https://img.shields.io/github/stars/kabooboo/giphon?style=social)\n\n---\n\n✨ Giphon is the contraction of 🦊 _Gitlab_ and 🫗 _siphon_. This CLI tools allows users\nto recursively clone all projects in a given Gitlab group or instance.\n\n## Motivation\n\nThis project aims to provide a tool capable of replicating a Gitlab group's\nstructure into a directory structure.\n\nLocally cloned projects enable users to use familiar CLI tools such as `grep`\nand `sed` directly into the projects' tree structure.\n\n## Demo\n\n![Usage GIF](docs/assets/usage.gif)\n\n## Installation\n\nTo install `giphon`, simply run:\n\n```sh\npip install --user giphon\n```\n\nAnd if you wish to use giphon by simply calling `giphon`, you can set-up an \nalias in your `.bashrc` (or other, if you have another shell):\n\n```sh\necho 'alias giphon=\"/usr/bin/env python3 -m giphon\"' \u003e\u003e ~/.bashrc\n```\n\n## Parameters\n\nThe `giphon` tool allows for the following parameters:\n\n- **namespace** (CLI: `--namespace`): The Gitlab namespace to be cloned. `/`\n  defaults to the whole instance.\n- **output** (CLI: `--output`): The target path to clone the repositories to.\n- **gitlab_token**: (CLI: `--gitlab-token`, env: `GITLAB_TOKEN`): The Personal\n  Access Token authenticating the user.\n- **gitlab_url**: (CLI: `--gitlab-url`, env: `GITLAB_URL`): The URL of the Gitlab\n  instance to clone the repositories from. Defaults to `\"https://gitlab.com\"`\n- **fetch_repositories**: (CLI: `--fetch-repositories`/`--no-fetch-repositories`):\n  Whether to fetch remotes on repositories that already exist.\n- **save_ci_variables**: (CLI: `--save-ci-variables`/`--no-save-ci-variables`):\n  Whether to download CI/CD variables to a .env directory.\n- **clone_archived** (CLI: `--clone-archived`/`--no-clone-archived`): Whether\n  to also clone archived repository.\n- **clone_through_ssh**: (CLI: `--clone-through-ssh`/`--no-clone-through-ssh`):\n  Whether to use the SSH protocol or the HTTPS protocol to clone the git\n  repositories\n- **gitlab_username** (CLI: `--gitlab-username`, env: `GITLAB_USERNAME`): The\n  username to use, when cloning through HTTPS.\n- **verbose**: (CLI: `--verbose`/`-v`): The level of verbosity\n\n## Running programmatically\n\nYou can import the main function from `giphon` as such:\n\n```python\nfrom pathlib import Path\n\nfrom giphon.siphon import siphon\n\nsiphon(\n    namespace=Path(\"my-namespace\"),\n    output=Path(\"~/Projects\"),\n    gitlab_token=\"\",\n    gitlab_url=\"https://gitlab.com\",\n    fetch_repositories=True,\n    save_ci_variables=False,\n    clone_archived=False,\n    verbose=False,\n)\n```\n\nThe function takes as inputs the same parameters from the CLI tool.\n\n---\n\nLogo is © from [**Midjourney**](https://midjourney.com)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkabooboo%2Fgiphon","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkabooboo%2Fgiphon","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkabooboo%2Fgiphon/lists"}