{"id":22209570,"url":"https://github.com/amacado/handelsregister-cli","last_synced_at":"2025-10-23T18:54:19.658Z","repository":{"id":264502145,"uuid":"868625415","full_name":"amacado/handelsregister-cli","owner":"amacado","description":"Unofficial CLI allowing to interact with handelsregister.de","archived":false,"fork":false,"pushed_at":"2025-03-27T22:11:45.000Z","size":118,"stargazers_count":5,"open_issues_count":5,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-10-04T05:51:44.074Z","etag":null,"topics":["api","cli","docker","handelsregister"],"latest_commit_sha":null,"homepage":"","language":"PHP","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/amacado.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2024-10-06T21:13:15.000Z","updated_at":"2025-05-29T15:34:26.000Z","dependencies_parsed_at":"2025-07-07T03:09:19.364Z","dependency_job_id":"e598fbea-16b0-4b4f-b31e-be2d3b760fcc","html_url":"https://github.com/amacado/handelsregister-cli","commit_stats":null,"previous_names":["amacado/handelsregister-cli"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/amacado/handelsregister-cli","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/amacado%2Fhandelsregister-cli","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/amacado%2Fhandelsregister-cli/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/amacado%2Fhandelsregister-cli/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/amacado%2Fhandelsregister-cli/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/amacado","download_url":"https://codeload.github.com/amacado/handelsregister-cli/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/amacado%2Fhandelsregister-cli/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":280675594,"owners_count":26371564,"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","status":"online","status_checked_at":"2025-10-23T02:00:06.710Z","response_time":142,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["api","cli","docker","handelsregister"],"created_at":"2024-12-02T19:33:33.855Z","updated_at":"2025-10-23T18:54:19.628Z","avatar_url":"https://github.com/amacado.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"# TL;DR\n```\ndocker run --volume ${pwd}/handelsregister-cli-storage:/app/storage amacado/handelsregister-cli:latest --help\n```\n\n# About\nThis is an **unofficial** CLI allowing to interact with [handelsregister.de](https://www.handelsregister.de/) as an alternative approach to\nthe python CLI provided by [github.com/bundesAPI/handelsregister](https://github.com/bundesAPI/handelsregister).\n\nThe _Handelsregister_ is a publicly accessible directory that records information on registered merchants in a specific region \nwithin the framework of registration law. Entries are mandatory for the facts or legal relationships listed exhaustively in the \nHGB, AktG and GmbHG. In addition, other facts can also be entered if this serves the purpose of the commercial register and\nthere is a significant interest of legal transactions in their entry.\n\nAccess to the commercial register and the documents deposited there is permitted to anyone for information purposes in accordance \nwith § 9 Abs. 1 HGB[^1].\n\n\u003e [!IMPORTANT] \n\u003e With reference to the terms of use[^2], a limit of **60 requests per hour** applies, which can be **penalized \n\u003e if exceeded**. The use of this tool is at your own risk and the authors distance themselves from any misuse of the service.\n\n\u003e [...]\n\u003e 5.) Es ist unzulässig, mehr als 60 Suchen oder Aufrufe von Rechtsträgern pro Stunde im Registerportal vorzunehmen. \n\u003e Kann das berechtigte Erfordernis für eine höhere Abrufhäufigkeit nachgewiesen werden, besteht die Möglichkeit, \n\u003e bei der Servicestelle Registerportal beim AG Hagen einen Antrag auf einen Zugang mit einer registrierten IP-Adresse \n\u003e nach Ziffer 7) zu stellen.\n\u003e [...]\n\u003e\n\u003e 7.) Bei der Servicestelle Registerportal kann beantragt werden, eine IP-Adresse zur Nutzung des \n\u003e Registerportals zu registrieren, für die die Regel nach Ziffer 5) Satz 1 nicht gilt (Whitelist-IP).\n\u003e In dem Antrag muss angegeben werden, in welchem Umfang Informationen aus dem Registerportal \n\u003e abgerufen werden und zu welchen Zwecken diese Abrufe erfolgen. Die Antragstellerin/ der Antragsteller muss\n\u003e sich verpflichten, die Vorgaben aus der Nutzungsordnung einzuhalten. Falls sich Anhaltspunkte ergeben, dass \n\u003e eine Nutzerin/Nutzer mit ihren/seinen Abrufen oder Suchen in einem bestimmten Zeitpunkt gegen \n\u003e § 9 Abs. 1 S. 1 HGB verstößt, muss gegenüber der Servicestelle das Interesse an der übermäßigen Nutzung\n\u003e des Services nachgewiesen werden können. Kann ein Nachweis nicht erbracht werden, kann die Registrierung\n\u003e widerrufen werden.\n\u003e [...]\n\n## License\nThe CLI and source code is published under **Apache License 2.0** (see [LICENSE.md](./LICENSE.md)).\n\n# Usage\nThe CLI must be executed using `php` this can be achieved either by locally installing php[^3] or using the provided\nDocker Container. For readability the following examples are based on the standalone version.\n\n## Parameters and examples\nSee a full list of all parameters and options by passing `--help` as option to the CLI.\n\n```shell\nphp handelsregister-cli --help\n```\n```\nUsage:\n  handelsregister-cli [options] [--] [\u003clanguage\u003e [\u003cdownload\u003e]]\n\nArguments:\n  language                                     Language which is used for interaction with `Handelsregister`. [default: \"DE\"]\n  download                                     Select which file type you want to download (AD|CD|HD|SI). [default: \"AD\"] \n\nOptions:\n      --state[=STATE]                          Select zero, one or more federal states to search in. If none are passed, the search will not be limited to a specific state. Valid codes are based on iso:code:3166:DE. (multiple values allowed)\n      --keywords[=KEYWORDS]                    Search for company or keywords.\n      --keywords-option[=KEYWORDS-OPTION]      Select an option how `keywords` are treated; One of (all|any|exact). [default: \"any\"]\n      --keywords-match-similar                 If flag is set, similar matching keywords will be included in results.\n      --subsidiary-office[=SUBSIDIARY-OFFICE]  Subsidiary / registered office.\n      --include-deleted                        If flag is set, search results will also include deleted companies.\n      --only-branches                          If flag is set, search only for branches in accordance with new law.\n      --register-type[=REGISTER-TYPE]          Type of register.\n      --register-number[=REGISTER-NUMBER]      Company register number.\n      --register-court[=REGISTER-COURT]        Register court.\n      --legal-status[=LEGAL-STATUS]            Company legal status (input value is language-dependent).\n      --country[=COUNTRY]                      Country where the company is located (input value is language-dependent).\n      --postal-code[=POSTAL-CODE]              Postal code where the company is located.\n      --location[=LOCATION]                    Location/City where the company is located.\n```\n\nPerform a search with a selected court, register type and number (Deutsche Bahn AG):\n```shell\nphp handelsregister-cli --register-type=HRB --register-number=50000 --register-court='Berlin (Charlottenburg)'\n```\n\nPerform a search with a selected court, register type and number (Deutsche Bahn AG) and download the structured xml data (`SI`): \n```shell\nphp handelsregister-cli DE SI --register-type=HRB --register-number=50000 --register-court='Berlin (Charlottenburg)'\n```\n\nPerform a search in multiple federal states (`BW` Baden-Württemberg, `NI` Niedersachsen):\n```shell\nphp handelsregister-cli --state=BW --state=NI\n```\n\n### Docker Container (Quickstart) ![image](https://badgen.net/static/-/recommended?label\u0026color=blue)\nReplace `${pwd}/handelsregister-cli-storage` with a local path on your hostsystem where the downloaded files, logs and screenshots will be stored.\nPass any additional parameters like `--help` at the end:\n```shell\ndocker run --volume ${pwd}/handelsregister-cli-storage:/app/storage amacado/handelsregister-cli:latest [--help]\n```\n\n### Standalone CLI\n#### Requirements\n* `\"php\": \"^8.2.0\"`\n* php extension `curl`\n* php extension `fileinfo`\n* php extension `zip`\n\n\u003e [!CAUTION]\n\u003e Standalone CLI is a prototype and not yet fully functional. Usage of the Docker container (quickstart) is recommended.\n\n# Development\n## Getting started\nWe use [Docker](https://www.docker.com/) to ship a build and development environment to get you started:\n```shell\ndocker compose up [--build] [-d]\n```\nConnect to the development which allows you to interact with the cli:\n```shell\ndocker exec -it handelsregister-cli-development /bin/bash\nphp ./handelsregister-cli -v\n```\n\n## Build production docker container\n```shell\ndocker build -f .\\docker\\production\\Dockerfile . -t amacado/handelsregister-cli:latest\n```\n\n## Build a standalone application\nSee [laravel-zero.com/docs/build-a-standalone-application](https://laravel-zero.com/docs/build-a-standalone-application) for more details:\n```shell\nphp ./handelsregister-cli app:build\n```\n\n## Work in progress / ideas / TODO / bugs\nGitHub [issues](https://github.com/amacado/handelsregister-cli/issues) are used to track features, ideas and bugs. Feel free to contribute\nvia pull request or issue creation with bug reports and feature requests.\n\n[^1]: [https://www.gesetze-im-internet.de/hgb/__9.html](https://www.gesetze-im-internet.de/hgb/__9.html) (2024-10-04)\n[^2]: [https://www.handelsregister.de/rp_web/welcome.xhtml](https://www.handelsregister.de/rp_web/welcome.xhtml) | Auszug aus Nutzungsbedingungen (2024-10-04)\n[^3]: [https://www.php.net/manual/en/install.php](https://www.php.net/manual/en/install.php)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Famacado%2Fhandelsregister-cli","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Famacado%2Fhandelsregister-cli","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Famacado%2Fhandelsregister-cli/lists"}