{"id":36552311,"url":"https://github.com/docat-org/docatl","last_synced_at":"2026-02-13T17:14:23.921Z","repository":{"id":44711808,"uuid":"417033494","full_name":"docat-org/docatl","owner":"docat-org","description":" docatl, the docat cli 🙀","archived":false,"fork":false,"pushed_at":"2023-09-24T08:49:19.000Z","size":104,"stargazers_count":18,"open_issues_count":2,"forks_count":2,"subscribers_count":2,"default_branch":"main","last_synced_at":"2026-01-12T14:24:58.333Z","etag":null,"topics":["api","cli","client","docat"],"latest_commit_sha":null,"homepage":"","language":"Go","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/docat-org.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,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-10-14T07:35:04.000Z","updated_at":"2024-12-19T09:08:20.000Z","dependencies_parsed_at":"2023-09-24T10:33:05.636Z","dependency_job_id":null,"html_url":"https://github.com/docat-org/docatl","commit_stats":null,"previous_names":["docat-org/docat-cli"],"tags_count":21,"template":false,"template_full_name":null,"purl":"pkg:github/docat-org/docatl","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/docat-org%2Fdocatl","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/docat-org%2Fdocatl/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/docat-org%2Fdocatl/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/docat-org%2Fdocatl/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/docat-org","download_url":"https://codeload.github.com/docat-org/docatl/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/docat-org%2Fdocatl/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29412789,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-13T06:24:03.484Z","status":"ssl_error","status_checked_at":"2026-02-13T06:23:12.830Z","response_time":78,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"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","client","docat"],"created_at":"2026-01-12T06:36:35.538Z","updated_at":"2026-02-13T17:14:23.913Z","avatar_url":"https://github.com/docat-org.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# docatl, the docat cli 🙀\n\n![docat](https://github.com/docat-org/.github/blob/main/logo.png?raw=true)\n\n**Manage your docat documentation with ease.**\n\n[![build](https://github.com/docat-org/docatl/workflows/Ci/badge.svg)](https://github.com/docat-org/docatl/actions)\n\n## Getting Started\n\nDownload the [latest Release binary](https://github.com/docat-org/docatl/releases/latest) for your platform\nand start pushing your documentation:\n\n```sh\ndocatl push --host https://docat.company.io ./docs.zip myproject v1.0.0\n```\n\nor with an implicit build:\n\n```sh\ndocatl push --host https://docat.company.io ./docs/ myproject v1.0.0\n```\n\nor with an explicit build step and push an artifact:\n\n```sh\ndocatl build ./docs --host https://docat.company.io --project myproject --version v1.0.0\ndocatl push ./docs_myproject_v1.0.0.zip\n```\n\n**Supported commands:**\n\n* `push`: pushing documentation to a docat server\n* `tag`: tag a documentation on a docat server\n* `claim`: claim a documentation project on a docat server\n* `delete`: delete documentation from a docat server\n* `build`: build a documentation artifact to push to a docat server\n* `push-icon`: push an icon for a specific documentation to a docat server\n* `rename`: rename a project on a docat server\n* `hide`: hide a version on a docat server\n* `show`: show a previously hidden version on a docat server\n\n## Installation\n\n* Binaries for your platform are attached to each release [here](https://github.com/docat-org/docatl/releases)\n* Container images are available on ghcr.io [here](https://github.com/docat-org/docatl/pkgs/container/docatl)\n\n### Using Go\n\nYou can install the package using go directly:\n\n```sh\ngo install github.com/docat-org/docatl@latest\n```\n\nThe `docatl` binary will be placed in `$GOPATH/bin`.\n\n### Using wget / curl\n\nYou can use `wget` or `curl` to download a release.\nMake sure that you are using the correct version and platform names in the URL.\n\nE.g downloading `v0.1.0` for `Linux` `x86_64`:\n```sh\nwget https://github.com/docat-org/docatl/releases/download/v0.1.0/docatl_0.1.0_Linux_x86_64 -O ~/bin/docatl\n```\n\n### Using docker\n\nYou can run `docatl` in a docker container:\n\n```sh\ndocker run -v $PWD:/docs ghcr.io/docat-org/docatl:latest push ./docs.zip myproject v1.0.0\n```\n\nNotice that your `$PWD` will be mounted as volume to the containers `/docs` directory.\nThe `.docatl.yaml` and `./docs.zip` file (in the example case) are relative to that `/docs` directory.\n\n## Ci System Support\n\nWe build a [Container Image](https://github.com/docat-org/docatl/pkgs/container/docatl) you can use\nin your Ci system.\n\n### GitLab Ci\n\nUse the following Job template to publish the docs:\n\n```yaml\ndeploy-docs:\n  image: ghcr.io/docat-org/docatl:latest-alpine\n  variables:\n    DOCATL_HOST: https://docat.company.io\n    DOCATL_API_KEY: blabla\n    DOCATL_PROJECT: $CI_PROJECT_NAME\n    DOCATL_VERSION: $CI_COMMIT_TAG\n  script:\n    - docatl push ./docs\n```\n\nAutomatically tag with `latest`:\n\n```yaml\ndeploy-docs:\n  image: ghcr.io/docat-org/docatl:latest-alpine\n  variables:\n    DOCATL_HOST: https://docat.company.io\n    DOCATL_API_KEY: blabla\n    DOCATL_PROJECT: $CI_PROJECT_NAME\n    DOCATL_VERSION: $CI_COMMIT_TAG\n  script:\n    - docatl push ./docs --tag latest\n```\n\nNote: you must use the `-alpine` variant on the container image, because GitLab Ci needs a shell.\n\n## Configuration\n\nYou can configure `docatl` with either command line arguments, env variables and/or a config file (evaluated in that order of precedence).\n\n### Config File\n\nThe config file must be at the working directory at `.docatl.yaml`, e.g.:\n\n```yaml\nhost: https://docat.company.io\napi-key: blabla\n```\n\n### Environment Variable\n\nThe `DOCATL_` must be used, e.g.:\n\n```sh\nDOCATL_API_KEY=blabla docatl push ...\n```\n\n## Shell auto-completion\n\nRun `docatl completion` to install auto-completion for your shell.\n\n## Pronounciation\n\n`docatl` must strictly be pronounced with an Austrian accent, see proof from [@randombenj](https://github.com/randombenj) (in swiss german):\n\n![pronounciation](docs/pronounciation.png)\n\n## OMG. You could have just used `curl`\n\nYes, absolutely. However, there are a few advantages when using `docatl`.\nSome of those are:\n\n* easily discover the interaction points with docat using `docatl help`\n* easily work with configuration using a config file or environment variables\n* nice error messages\n* don't have to bother with all the unnessecary flags for this use case `curl` provide\n* standalone binary for your platform available\n* container image available to run in your Continuous Integration platform\n\nNot convinced? Use `curl` ;)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdocat-org%2Fdocatl","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdocat-org%2Fdocatl","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdocat-org%2Fdocatl/lists"}