{"id":13831583,"url":"https://github.com/yuzutech/kroki-cli","last_synced_at":"2025-04-09T21:13:54.017Z","repository":{"id":41254988,"uuid":"170371643","full_name":"yuzutech/kroki-cli","owner":"yuzutech","description":"A Kroki CLI","archived":false,"fork":false,"pushed_at":"2025-04-06T16:09:03.000Z","size":4161,"stargazers_count":70,"open_issues_count":5,"forks_count":5,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-04-09T21:13:45.813Z","etag":null,"topics":["cli","diagrams","golang","images","kroki"],"latest_commit_sha":null,"homepage":null,"language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/yuzutech.png","metadata":{"files":{"readme":"README.adoc","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":"2019-02-12T18:44:54.000Z","updated_at":"2025-03-18T07:12:36.000Z","dependencies_parsed_at":"2024-06-03T04:10:55.445Z","dependency_job_id":"1ee7c443-50ac-4643-9453-1379d934a202","html_url":"https://github.com/yuzutech/kroki-cli","commit_stats":null,"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yuzutech%2Fkroki-cli","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yuzutech%2Fkroki-cli/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yuzutech%2Fkroki-cli/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yuzutech%2Fkroki-cli/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/yuzutech","download_url":"https://codeload.github.com/yuzutech/kroki-cli/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248111972,"owners_count":21049578,"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","diagrams","golang","images","kroki"],"created_at":"2024-08-04T10:01:31.968Z","updated_at":"2025-04-09T21:13:53.997Z","avatar_url":"https://github.com/yuzutech.png","language":"Go","funding_links":[],"categories":["Go"],"sub_categories":[],"readme":"= Kroki CLI\n\nimage:https://github.com/yuzutech/kroki-cli/workflows/CI/badge.svg[Build Status,link=https://github.com/yuzutech/kroki-cli/actions?query=workflow%3ACI]\n\nA CLI for https://kroki.io.\n\n== Usage\n\n kroki convert hello.dot\n\nBy default, the diagram type will be inferred from the diagram file extension and the default output format will be `SVG`.\n\nLong format:\n\n kroki convert hello.dot --type dot --format svg\n\nThe output format can also be inferred from the output file using the `--out-file` flag:\n\n kroki convert simple.er --out-file out.png\n\nRead from `stdin`:\n\n cat hello.dot | kroki convert - -t dot\n\nBy default, when reading from `stdin` using `-`, the result will be output to `stdout`.\nIf you want to output to a file you can use `-o`:\n\n cat hello.dot | kroki convert - -t dot -o out.png\n\nSimilarly, you can also output to `stdout` when reading from a file using the special value `-` with the `--out-file` flag:\n\n kroki convert simple.er --out-file -\n\n== Installation\n\nThe https://github.com/yuzutech/kroki-cli/releases[releases page] provides binaries for each version to download.\n\nYou can also install the package directly from source. The compiled binary will be put into `$GOPATH/bin/` or `$HOME/go/bin/` if `$GOPATH` is not set:\n\n```bash\ngo install github.com/yuzutech/kroki-cli/cmd/kroki@latest\n```\n\n== Configuration\n\nTo configure the endpoint, you can use a configuration file.\nThe CLI will look for the following locations:\n\n* `/etc/kroki.yml`\n* `$HOME/kroki.yml`\n* `kroki.yml`\n\nYou can also specify an alternate config file using the `--config` flag:\n\n kroki convert hello.dot --config config.yml\n\nThe config file should contain the endpoint URL and the HTTP timeout.\nBy default, Kroki will use the demonstration server: https://demo.kroki.io and a timeout of 20 seconds.\n\nCAUTION: Please note that the demonstration server usage is restricted to reasonable, non-commercial use-cases.\nWe provide no guarantee regarding uptime or latency.\n\nExample:\n\n.kroki.yml\n```yml\nendpoint: 'https://localhost:8000'\ntimeout: 30s\n```\n\nIf you don't want to use a file you can also use the following environment variables:\n\n* `KROKI_ENDPOINT`\n* `KROKI_TIMEOUT`\n\n[]\n\n KROKI_ENDPOINT=https://localhost:8000 KROKI_TIMEOUT=1m kroki convert hello.dot\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyuzutech%2Fkroki-cli","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fyuzutech%2Fkroki-cli","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyuzutech%2Fkroki-cli/lists"}