{"id":17276757,"url":"https://github.com/jobehi/mkproj","last_synced_at":"2025-04-16T03:40:47.515Z","repository":{"id":257827026,"uuid":"871644524","full_name":"jobehi/mkproj","owner":"jobehi","description":"An Interactive CLI Tool to Setup Your Project Trees","archived":false,"fork":false,"pushed_at":"2024-10-15T23:40:10.000Z","size":193,"stargazers_count":21,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-03-29T04:42:36.196Z","etag":null,"topics":["cli","golang"],"latest_commit_sha":null,"homepage":"","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/jobehi.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","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":"2024-10-12T14:37:54.000Z","updated_at":"2024-10-22T14:58:54.000Z","dependencies_parsed_at":"2024-10-17T03:58:11.971Z","dependency_job_id":null,"html_url":"https://github.com/jobehi/mkproj","commit_stats":null,"previous_names":["jobehi/mkproj"],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jobehi%2Fmkproj","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jobehi%2Fmkproj/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jobehi%2Fmkproj/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jobehi%2Fmkproj/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jobehi","download_url":"https://codeload.github.com/jobehi/mkproj/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":249191702,"owners_count":21227625,"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","golang"],"created_at":"2024-10-15T09:01:04.218Z","updated_at":"2025-04-16T03:40:47.497Z","avatar_url":"https://github.com/jobehi.png","language":"Go","funding_links":[],"categories":["Go"],"sub_categories":[],"readme":"# mkproj: An Interactive CLI Tool to Setup Your Project Trees 🌳\n\n`mkproj` is a simple and effective command-line interface (CLI) tool designed to help developers quickly create, visualize, and manage their project structures. With an intuitive interactive mode and flexible commands, `mkproj` provides a fast way to organize your project files and folders.\n\n## Features\n\n\nInteractive Mode             |  Interactive Mode output\n:-------------------------:|:-------------------------:\n![](doc/screenshot_1.png)  |  ![](doc/screenshot_2.png)\n\n\n- **Interactive Mode**: Easily create and modify your project structure interactively using standard editing keys. Build your ideal layout with minimal friction.\n- **Text-Based Structure Creation**: Create a project structure from a text file or piped input.\n- **Tree View**: Display the current directory structure, with the option to include or exclude hidden files.\n\n## Installation\n\n`mkproj` is available on Homebrew for macOS and can be installed from source for other platforms.\n\n### Install mkproj on macOS using Homebrew\n\nTo install `mkproj` on macOS using Homebrew, run:\n\n```sh\n  brew tap jobehi/mkproj\n\n  brew install mkproj\n```\n\nFor other platforms, you can download and build the binary from the [source code repository](#setup-mkproj-globally-from-source-code).\n\n\n## Usage\n\n### Command Overview\n\n```sh\nmkproj [command] [options]\n```\n\n- **create**: Create a project structure from a text file or piped input.\n- **tree**: Display the current directory structure.\n- **help**: Display this help message.\n\n### Options\n\n- `--root=\u003cpath\u003e`: Specify the root directory for your project structure (default is the current directory).\n- `--file=\u003cpath\u003e`: Provide a file that contains the project structure (used with `create`).\n\n### Interactive Mode\n\nBy default, `mkproj` starts in interactive mode, where you can manually build your project structure:\n\n- Use standard editing keys to modify the structure.\n- Press **F2** to save and create the structure.\n- Press **Esc** to exit without saving.\n\n### Examples\n\n- **Start in Interactive Mode**:\n  ```sh\n  mkproj\n  ```\n  This launches `mkproj` in an interactive environment where you can create and edit your project structure on the fly.\n\n- **Create a Project Structure from a Text File**:\n  ```sh\n  mkproj create --file=structure.txt --root=./new_project\n  ```\n  This command reads the project structure from `structure.txt` and creates it in the specified root directory.\n\n- **Display the Current Directory Tree**:\n  ```sh\n  mkproj tree --root=./my_project\n  ```\n  Displays the directory structure of `./my_project` without showing hidden files.\n\n- **Display the Directory Tree Including Hidden Files**:\n  ```sh\n  mkproj tree --root=./my_project --all\n  ```\n  Displays the directory tree of `./my_project`, including hidden files.\n\n## Project Structure Input Format\n\nThe input structure can be created interactively or provided as a text file. You can use dashes (`-`) for depth and suffix `:file` to mark an entry as a file (for files with no extensions). For example:\n\n```txt\nproject-root\n- src\n-- main.go\n-- utils\n--- helper.go\n- README.md\n- .gitignore:file\n```\n\n### Setup mkproj Globally From Source Code\n\nTo set up `mkproj` globally on macOS from the source code, follow these steps:\n\n1. **Clone the Repository**:\n   ```sh\n   git clone https://github.com/jobehi/mkproj.git\n   cd mkproj\n   ```\n\n2. **Build the Binary**:\n   Build the `mkproj` binary using Go:\n   ```sh\n   go build -o mkproj\n   ```\n\n3. **Move the Binary to `/usr/local/bin`**:\n   Move the compiled binary to `/usr/local/bin` to make it accessible globally:\n   ```sh\n   sudo mv mkproj /usr/local/bin/\n   sudo chmod +x /usr/local/bin/mkproj\n   ```\n\n4. **Verify Installation**:\n   You can now use `mkproj` from anywhere in your terminal:\n   ```sh\n   mkproj help\n   ```\n\n\n## Contributing\n\nContributions are welcome! Please open an issue or a pull request on the [GitHub repository](https://github.com/jobehi/mkproj) to report bugs or suggest improvements.\nRefer to the [Contributing Guidelines](CONTRIBUTING.md) for more information.\n\n## License\n\n`mkproj` is released under the [MIT License](LICENSE).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjobehi%2Fmkproj","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjobehi%2Fmkproj","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjobehi%2Fmkproj/lists"}