{"id":18829770,"url":"https://github.com/codysnider/polo-local-dev","last_synced_at":"2026-01-23T19:30:15.507Z","repository":{"id":117242433,"uuid":"546228774","full_name":"codysnider/polo-local-dev","owner":"codysnider","description":null,"archived":false,"fork":false,"pushed_at":"2022-11-29T17:19:19.000Z","size":47,"stargazers_count":0,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"master","last_synced_at":"2024-12-30T06:27:08.774Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":false,"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/codysnider.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}},"created_at":"2022-10-05T18:46:34.000Z","updated_at":"2022-10-18T21:23:49.000Z","dependencies_parsed_at":null,"dependency_job_id":"2c3d589d-5698-475f-8b91-d81b94650964","html_url":"https://github.com/codysnider/polo-local-dev","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codysnider%2Fpolo-local-dev","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codysnider%2Fpolo-local-dev/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codysnider%2Fpolo-local-dev/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codysnider%2Fpolo-local-dev/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/codysnider","download_url":"https://codeload.github.com/codysnider/polo-local-dev/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":239765374,"owners_count":19693129,"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":[],"created_at":"2024-11-08T01:46:06.209Z","updated_at":"2026-01-23T19:30:15.446Z","avatar_url":"https://github.com/codysnider.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Poloniex Local Development Toolkit\n\n## Setup\n\nTo build the latest, run the following script with MakeMeAdmin active:\n\n```bash\n./build.sh\n```\n\nThe last line will be the path of the executable. You should see `/usr/local/bin/gopld`.\n\nAttempt running it with:\n```bash\npld\n```\n\n## Usage Examples\n\n**Common Flags**\n\n*Note: Not all commands support json and verbose output but will not fail if argument is present.*\n\n```\n-h, --help      Help\n-j, --json      JSON output\n-v, --verbose   Verbose output\n```\n\n**Project-based Command Flags**\n\n\u003ca name=\"project-flags\"\u003e\u003c/a\u003e\n\n```\n-a, --all              All projects\n-g, --group string     Project group\n-h, --help             Help\n-i, --ignore-deps      Ignore dependency chain\n-p, --project string   Single project\n```\n\n### Config\n\n**Reload**\n\nWill refresh with project configurations with default/distributed project config.\n\n```bash\npld config reload\n```\n\n### Doctor\n\nWill run a sanity check on local environment state. This checks for system configuration, installed applications and authentication state.\n\n```bash\npld doctor\n```\n\n### Build\n\nUses [project-based flags](#project-flags)\n\n**All**\n```bash\npld build --all\n```\n\n**Project Group**\n```bash\npld build -g frontend\n```\n\n**Single Project (with dependencies)**\n```bash\npld build -p frontend-login\n```\n\n**Single Project (without dependencies)**\n```bash\npld build -i -p frontend-login\n```\n\n### Start\n\nUses [project-based flags](#project-flags)\n\n**All**\n```bash\npld start --all\n```\n\n**Project Group**\n```bash\npld start -g frontend\n```\n\n**Single Project (with dependencies)**\n```bash\npld start -p frontend-login\n```\n\n**Single Project (without dependencies)**\n```bash\npld start -i -p frontend-login\n```\n\n### Clone\n\nUses [project-based flags](#project-flags)\n\n**All**\n```bash\npld clone --all\n```\n\n**Project Group**\n```bash\npld clone -g support\n```\n\n### Fork\n\nUses [project-based flags](#project-flags)\n\n**All**\n```bash\npld fork --all\n```\n\n**Project Group**\n```bash\npld fork -g support\n```\n\n### Dependency Tools\n\nUses [project-based flags](#project-flags)\n\n**Graph**\n\nDisplay the dependency tree\n\n```bash\npld dep graph --all\n```\n\n**Execution Order**\n\nDisplay the execution order based on dependencies\n\n```bash\npld dep order --all\n```\n\n**Explain**\n\nCombination of graph and execution order\n\n```bash\npld dep explain --all\n```\n\n### Project Details\n\nUses [project-based flags](#project-flags)\n\nGet details about project\n\n```bash\npld project details --all\n```\n\n## Config Format\n\n*Note: All project config files must be named in the *.project.json format and each can contain any number of projects. These are converted and copied during PLD install and config reload operations.* \n\n### Parameters\n\n| Parameter Name     | Parameter Description                                                                                         | Required |\n|--------------------|---------------------------------------------------------------------------------------------------------------|----------|\n| PROJECT-NAME       | Distinct name of project, must be universally unique in config files                                          | YES      |\n| REPO-NAME          | Repository name. Use for both git and filesystem operations                                                   | YES      |\n| DOCKER-NAME        | Name for project, must match with service name in docker compose                                              | YES      |\n| SERVICE-GROUP      | Optional service group membership for use with `--group` flags                                                | NO       |\n| DEFAULT-GIT-BRANCH | Base branch for repo, should be main or master unless a larger epic is in progress. Use for git sync commands | YES      |\n| BUILD-BASH-COMMAND | Build-phase bash command, any number can be defined, run in sequence and expect a 0 exit code                 | NO       |\n| BUILD-EXEC-PATH    | Filesystem location in which the paired command should execute                                                | NO       |\n| RUN-BASH-COMMAND   | Run-phase bash command, any number can be defined, run in sequence and expect a 0 exit code                   | NO       |\n| RUN-EXEC-PATH      | Filesystem location in which the paired command should execute                                                | NO       |\n\n### Format Template\n\n```json\n{\n  \"PROJECT-NAME\": {\n    \"repo\": \"REPO-NAME\",\n    \"name\": \"DOCKER-NAME\",\n    \"groups\": [\n      \"SERVICE-GROUP\",\n      \"SERVICE-GROUP\",\n      \"SERVICE-GROUP\"\n    ],\n    \"default_version\": \"DEFAULT-GIT-BRANCH\",\n    \"build_cmd\": [\n      {\n        \"command\": \"BUILD-BASH-COMMAND\",\n        \"path\": \"BUILD-EXEC-PATH\"\n      },\n      {\n        \"command\": \"BUILD-BASH-COMMAND\",\n        \"path\": \"BUILD-EXEC-PATH\"\n      },\n      {\n        \"command\": \"BUILD-BASH-COMMAND\",\n        \"path\": \"BUILD-EXEC-PATH\"\n      }\n    ],\n    \"run_cmd\": [\n      {\n        \"command\": \"RUN-BASH-COMMAND\",\n        \"path\": \"RUN-EXEC-PATH\"\n      },\n      {\n        \"command\": \"RUN-BASH-COMMAND\",\n        \"path\": \"RUN-EXEC-PATH\"\n      },\n      {\n        \"command\": \"RUN-BASH-COMMAND\",\n        \"path\": \"RUN-EXEC-PATH\"\n      }\n    ]\n  }\n}\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcodysnider%2Fpolo-local-dev","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcodysnider%2Fpolo-local-dev","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcodysnider%2Fpolo-local-dev/lists"}