{"id":20463873,"url":"https://github.com/lorddashme/craftman","last_synced_at":"2026-05-04T10:33:12.492Z","repository":{"id":72015417,"uuid":"203285415","full_name":"LordDashMe/craftman","owner":"LordDashMe","description":"An automation script that manage your dockerized local development setup.","archived":false,"fork":false,"pushed_at":"2022-08-14T14:22:21.000Z","size":25,"stargazers_count":1,"open_issues_count":0,"forks_count":1,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-07-15T22:05:01.486Z","etag":null,"topics":["automation","cli","docker","docker-compose","python","simple"],"latest_commit_sha":null,"homepage":"","language":"Python","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/LordDashMe.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":"2019-08-20T02:34:43.000Z","updated_at":"2022-08-14T14:22:24.000Z","dependencies_parsed_at":null,"dependency_job_id":"bc91e204-bce9-4c2c-b5e9-5366d680e8eb","html_url":"https://github.com/LordDashMe/craftman","commit_stats":null,"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"purl":"pkg:github/LordDashMe/craftman","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LordDashMe%2Fcraftman","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LordDashMe%2Fcraftman/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LordDashMe%2Fcraftman/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LordDashMe%2Fcraftman/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/LordDashMe","download_url":"https://codeload.github.com/LordDashMe/craftman/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LordDashMe%2Fcraftman/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32604154,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-04T10:08:07.713Z","status":"ssl_error","status_checked_at":"2026-05-04T10:08:02.005Z","response_time":58,"last_error":"SSL_read: 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":["automation","cli","docker","docker-compose","python","simple"],"created_at":"2024-11-15T13:13:22.027Z","updated_at":"2026-05-04T10:33:12.463Z","avatar_url":"https://github.com/LordDashMe.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Craftman\n\nAn automation script that manage your dockerized local development setup.\n\n## The Purpose\n\nIf you want to dockerize your local development and manage it in an easier way, this will be your friend to help or guide you to do that in a simple way.\n\n## Requirement(s)\n\n- Docker version 17.x.x or higher.\n\n- Docker Compose version 1.17.x or higher.\n\n- Python 2.7.x or higher.\n\n## Install\n\n- Download the latest release here: [Latest Release of Craftman](https://github.com/LordDashMe/craftman/archive/0.2.0.zip)\n\n- Check other releases here: [Releases of Craftman](https://github.com/LordDashMe/craftman/releases)\n\n## Folder Structure\n\n```bash\n.\n├── boilerplate\n│   ├── .sample-docker-compose\n│   ├── .sample-env\n│   ├── .sample-README\n├── service\n│   ├── category\n│       ├── service\n│           ├── .env\n│           ├── docker-compose.yml\n│           ├── README.md\n├── storage\n│   ├── service-network\n├── .gitignore\n├── LICENSE\n├── README.md\n└── craftman\n```\n\n## Usage\n\n- To check the script available modules, use the command ```./craftman help```.\n\n- To check the options of a modules, use the command ```./craftman [module...] --help```.\n\n### Setup Network Development\n\n- To setup the development docker network provided by craftman automation script, use the command below:\n\n  ```text\n  ./craftman network\n  ```\n\n#### Network Specification\n\n- When using the provided development docker network setup, the specification or details are listed below:\n  \n  - Docker Network Name: development-network\n\n  - Network Class: A\n\n  - Subnet: 255.0.0.0/8\n\n  - IP Address: 116.0.0.0/116.255.255.254\n\n  - Port: 16000/65535\n\n### Setup Service\n\n- To setup a service/project, use the module ```./craftman service```.\n\n  ```text\n  ./craftman service --ip=116.0.0.2 --port=16002 --service=mysql-5.6 --category=common\n  ```\n\n### Setup Environment File\n\n- To setup an environment or ```.env``` file in the service/project, use the module ```./craftman environment```.\n\n  ```text\n  ./craftman environment --path=service/common/mysql-5.6/ --host=my-machine-name\n  ```\n\n  - By default craftman script will not include ```.env``` file when used to generate service/project.\n\n  - For \"flexibility\" purpose, the ```.env``` file should be manually create or apply by the crafter.\n\n  - The generated ```docker-compose.yml``` file requires the ```LOCAL_MACHINE_USERNAME``` ENV variable, thus requires to provide a ```.env``` in the same directory or level of the said file.\n\n  - The ```.env``` file will automatically read by the docker compose command as long as they are the same directory or level with ```docker-compose.yml```.\n\n  - If you want to deeply understand how environment work with the docker compose you can check this reference documentation: [Environment variable in Compose | Docker Documentation](https://docs.docker.com/compose/environment-variables/)\n\n### Check Storage\n\n- To check the last entry in the storage, use the module ```./craftman storage```.\n\n### Remove Service\n\n- To remove service entry, use the module ```./craftman service-delete --ip=\u003c192.168.x.x\u003e --service=\u003cservice-name\u003e --category=\u003ccategory-name\u003e```\n\n## Reference Tool(s)\n\n- [Subnet Calculator](https://www.calculator.net/ip-subnet-calculator.html?cclass=any\u0026csubnet=8\u0026cip=116.0.0.0\u0026ctype=ipv4\u0026printit=0\u0026x=49\u0026y=21)\n\n## License\n\nThis package is open-sourced software licensed under the [MIT license](https://opensource.org/licenses/MIT).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Florddashme%2Fcraftman","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Florddashme%2Fcraftman","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Florddashme%2Fcraftman/lists"}