{"id":20156503,"url":"https://github.com/nullbyto/commentize","last_synced_at":"2026-05-13T04:04:38.821Z","repository":{"id":138114996,"uuid":"444916594","full_name":"nullbyto/commentize","owner":"nullbyto","description":"A simple tool to create nice looking comment boxes for source files","archived":false,"fork":false,"pushed_at":"2022-02-05T23:56:03.000Z","size":34,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-02-28T08:52:58.812Z","etag":null,"topics":["cli","command-line","command-line-tool","comments","rust","rust-lang","terminal","tool"],"latest_commit_sha":null,"homepage":"https://nullbyto.github.io/tools/commentize","language":"Rust","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/nullbyto.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":"2022-01-05T18:52:18.000Z","updated_at":"2022-01-24T14:22:33.000Z","dependencies_parsed_at":null,"dependency_job_id":"0bf5037f-2efc-4da1-b4bd-3fe81e4a1429","html_url":"https://github.com/nullbyto/commentize","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nullbyto%2Fcommentize","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nullbyto%2Fcommentize/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nullbyto%2Fcommentize/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nullbyto%2Fcommentize/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/nullbyto","download_url":"https://codeload.github.com/nullbyto/commentize/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":241596276,"owners_count":19988044,"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","command-line","command-line-tool","comments","rust","rust-lang","terminal","tool"],"created_at":"2024-11-13T23:39:00.318Z","updated_at":"2026-05-13T04:04:38.735Z","avatar_url":"https://github.com/nullbyto.png","language":"Rust","funding_links":[],"categories":[],"sub_categories":[],"readme":"\n# Commentize\n\nThis is a simple command-line tool to turn any text or file into a nice looking comment box with options to change the box symbols and box dimensions.\nThe \"commentized\" text can be outputted to the terminal or added to one or more source files **Recursively**, with the option to add the text to the top or the bottom of the source file/s. The tool won't duplicate the *commentized* text if it's already added.\n\n\u003c!-- Example --\u003e\n### Example:\n![](https://github.com/nullbyto/commentize/raw/master/examples/1.png)\n\nIn this example we *commentized* a string \"Hello Github\" with right padding length 10 (-r), height padding length 2 (-y) (top/bottom) and edited the wall symbols to \"|||\" (-w). Which resulted in a nice looking comment box as shown.\n\nClick [here](https://github.com/nullbyto/commentize/tree/master/examples) to see all examples.\n  \n\n\u003c!-- GETTING STARTED --\u003e\n## Getting Started\n\nThis is an example on setting up the tool locally.\nTo get a local copy up and running follow these simple steps.\n\n There are two ways to get the tool:\n - Build it from source (recommended)\n - Download it pre-compiled from the [releases](https://github.com/nullbyto/commentize/releases) page\n\n### Prerequisites\n\nIf you choose to build the tool from source you need to have `rustc` and `cargo` installed:\n* Follow the instructions on https://rustup.rs/ to download and install rustc alongside cargo.\n\n### Building from source\n\n1. Clone the repo and change to the directory\n\n```sh\n$ git clone https://github.com/nullbyto/commentize.git\n$ cd commentize\n```\n\n2. Build the project\n```sh\n$ cargo build --release\n```\n\n3. Find your binary in the directory: **target/release**\n\n**Extra**: to be able to use the tool from anywhere on your pc, you need to add the directory with the binary into `PATH`.\n\n\n\u003cp  align=\"right\"\u003e(\u003ca  href=\"#top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n\u003c!-- USAGE --\u003e\n## Usage and options\n\nUsage and options should be self-explanatory from the **--help** menu.\n\n**Note**: you have to be located in the directory of the binary file to be able to use it unless it is in the `PATH`, which will not be covered how to do here.\n\n```sh\nCommentize 0.1.0\n\nUSAGE:\n\tcommentize.exe [FLAGS] [OPTIONS] --comment \u003ccomment\u003e --file \u003cfile\u003e [path]\n\nFLAGS:\n\t-a, --append \tAppend to file path\n\t-h, --help \tPrints help information\n\t-m, --modded \tModded style\n\t-o, --output \tOutput the comment\n\t-V, --version \tPrints version information\n\nOPTIONS:\n\t-c, --comment \u003ccomment\u003e \tComment to be added\n\t-f, --file \u003cfile\u003e \t\tText file to get comment from\n\t-y, --hp \u003cheight-pad\u003e \t\tHeight padding length\n\t-l, --left \u003cleft\u003e \t\tLeft side padding length\n\t-r, --right \u003cright\u003e \t\tRight side padding length\n\t-s, --symbol \u003csymbol\u003e \t\tSymbol to commnetize with\n\t-w, --wall \u003cwall\u003e \t\tWall symbol to commnetize with\n\t-x, --wp \u003cwidth-pad\u003e \t\tWidth Padding length\n\nARGS:\n\t\u003cpath\u003e\t\tPath to file or directory to commentize in the header\n```\n\n  \u003cp  align=\"right\"\u003e(\u003ca  href=\"#top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n\u003c!-- CONTRIBUTING --\u003e\n## Contributing\n\nContributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.\n\nIf you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag \"enhancement\".\n\nDon't forget to give the project a star!\n\n1. Fork the Project\n2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)\n3. Commit your Changes (`git commit -m \"Add some AmazingFeature\"`)\n4. Push to the Branch (`git push origin feature/AmazingFeature`)\n5. Open a Pull Request\n\n\u003cp  align=\"right\"\u003e(\u003ca  href=\"#top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnullbyto%2Fcommentize","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnullbyto%2Fcommentize","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnullbyto%2Fcommentize/lists"}