{"id":50479480,"url":"https://github.com/kukv/treedoc","last_synced_at":"2026-06-01T16:30:50.302Z","repository":{"id":356617241,"uuid":"1233334086","full_name":"kukv/treedoc","owner":"kukv","description":"A tree command extension that displays directory structure with sidecar comments.","archived":false,"fork":false,"pushed_at":"2026-05-08T22:34:20.000Z","size":60,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-05-08T23:23:14.579Z","etag":null,"topics":["cli","documentation","rust","tree"],"latest_commit_sha":null,"homepage":"","language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/kukv.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2026-05-08T21:05:57.000Z","updated_at":"2026-05-08T22:34:24.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/kukv/treedoc","commit_stats":null,"previous_names":["kukv/treedoc"],"tags_count":null,"template":false,"template_full_name":null,"purl":"pkg:github/kukv/treedoc","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kukv%2Ftreedoc","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kukv%2Ftreedoc/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kukv%2Ftreedoc/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kukv%2Ftreedoc/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/kukv","download_url":"https://codeload.github.com/kukv/treedoc/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kukv%2Ftreedoc/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":33784625,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-06-01T02:00:06.963Z","response_time":115,"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":["cli","documentation","rust","tree"],"created_at":"2026-06-01T16:30:49.542Z","updated_at":"2026-06-01T16:30:50.289Z","avatar_url":"https://github.com/kukv.png","language":"Rust","funding_links":[],"categories":[],"sub_categories":[],"readme":"# treedoc\n\nA `tree(1)`-style directory listing with one extra trick: each entry can carry a\nshort comment, kept alongside the project in a `.treedoc.yaml` sidecar file.\n\nUseful for README directory maps, architecture docs, onboarding guides, and\nblog posts that need to explain a repo layout.\n\n```\nmy-project/\n├── src/         # application code\n│   ├── lib.rs   # core logic\n│   └── main.rs  # entry point\n├── Cargo.toml   # dependency manifest\n└── README.md    # documentation\n```\n\n## Install\n\n### From crates.io\n\n```sh\ncargo install treedoc\n```\n\n### Pre-built binaries\n\nGrab the archive for your platform from the\n[GitHub Releases](https://github.com/kukv/treedoc/releases) page.\n\n### From source\n\n```sh\ngit clone https://github.com/kukv/treedoc.git\ncd treedoc\ncargo install --path .\n```\n\n## Usage\n\n### Show a tree\n\n```sh\ntreedoc            # current directory\ntreedoc src        # a specific path\ntreedoc -L 2       # limit recursion depth\ntreedoc -a         # include dotfiles\ntreedoc --no-ignore  # don't honour .gitignore\n```\n\nBy default, `.gitignore` rules are respected, dotfiles are hidden, and output\nis colored when stdout is a TTY (`NO_COLOR` and `--no-color` are honoured).\n\n### Manage comments\n\n```sh\ntreedoc init                          # create .treedoc.yaml with empty comments\ntreedoc set src/main.rs \"entry point\" # set or update one entry\ntreedoc edit                          # open .treedoc.yaml in $EDITOR\n```\n\n`treedoc init` refuses to overwrite an existing sidecar; pass `--force` to\nreplace it.\n\n### Output formats\n\n```sh\ntreedoc --format console   # default: colored TTY output\ntreedoc --format plain     # uncolored\ntreedoc --format markdown  # wrapped in a ``` code fence\n```\n\nUseful for pasting into a README:\n\n```sh\ntreedoc --format markdown \u003e\u003e README.md\n```\n\n## Sidecar format\n\n`.treedoc.yaml` is a flat mapping from relative path to comment string:\n\n```yaml\nsrc: \"application code\"\nsrc/main.rs: \"entry point\"\nsrc/lib.rs: \"core logic\"\nCargo.toml: \"dependency manifest\"\nREADME.md: \"documentation\"\n```\n\n- Paths use forward slashes regardless of the host OS.\n- A trailing slash on directory keys is optional (`src` and `src/` both match).\n- The sidecar file itself is hidden from the rendered tree.\n- Empty-string comments are kept in the YAML (so `treedoc init` can seed them)\n  but are not printed.\n\n## Options\n\n```\nUsage: treedoc [OPTIONS] [PATH]\n       treedoc \u003cCOMMAND\u003e\n\nCommands:\n  show  Render the tree (default)\n  init  Create a .treedoc.yaml populated with empty comments for every entry\n  set   Set or update a comment for a single path\n  edit  Open .treedoc.yaml in $EDITOR\n\nOptions:\n  -L, --depth \u003cDEPTH\u003e      Descend at most this many levels of directories\n  -a, --all                Show entries whose names begin with a dot\n      --no-ignore          Do not honour .gitignore rules\n      --no-color           Disable colored output\n      --format \u003cFORMAT\u003e    Output format [default: console]\n                           [possible values: console, plain, markdown]\n  -h, --help               Print help\n  -V, --version            Print version\n```\n\n## License\n\n[MIT](LICENSE)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkukv%2Ftreedoc","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkukv%2Ftreedoc","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkukv%2Ftreedoc/lists"}