{"id":19484065,"url":"https://github.com/rookie-ninja/rk","last_synced_at":"2025-04-25T16:33:13.134Z","repository":{"id":46809893,"uuid":"282633208","full_name":"rookie-ninja/rk","owner":"rookie-ninja","description":"Rookie command line tools","archived":false,"fork":false,"pushed_at":"2022-04-21T10:18:40.000Z","size":3317,"stargazers_count":34,"open_issues_count":2,"forks_count":4,"subscribers_count":1,"default_branch":"master","last_synced_at":"2024-06-20T00:29:10.802Z","etag":null,"topics":["cli","golang","rk"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/rookie-ninja.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-07-26T11:13:03.000Z","updated_at":"2024-05-26T15:13:22.000Z","dependencies_parsed_at":"2022-09-26T20:10:49.378Z","dependency_job_id":null,"html_url":"https://github.com/rookie-ninja/rk","commit_stats":null,"previous_names":[],"tags_count":11,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rookie-ninja%2Frk","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rookie-ninja%2Frk/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rookie-ninja%2Frk/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rookie-ninja%2Frk/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/rookie-ninja","download_url":"https://codeload.github.com/rookie-ninja/rk/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":224008609,"owners_count":17240415,"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","rk"],"created_at":"2024-11-10T20:19:05.821Z","updated_at":"2024-11-10T20:19:06.981Z","avatar_url":"https://github.com/rookie-ninja.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# rk\nA command-line interface for installing and building rk-boot applications.\n\n## Installation\n```shell script\ngo get github.com/rookie-ninja/rk/cmd/rk\n```\n\n## Quick Start\nWe'll start with a general overview of the commands. \nThere are more commands, and we will get into] usage below, but this shows the basic functionality.\n\n```shell script\nCOMMANDS:\n   build      Build project which contains build.yaml\n   clear      Clear target folder generated by rk build\n   docker     Build a docker image built with rk build command\n   install    Install third-party software\n   uninstall  Uninstall third-party software\n   pack       Pack target folder generated by rk build\n   run        Run server build by rk build\n   ut         Run unit test\n   help, h    Shows a list of commands or help for one command\n```\n\n## Command Overview\n\n### rk help\n```shell script\nrk help\n```\nPrint help message\n\n### rk install\n```shell script\nrk install \n```\n\nSubcommands\n```shell script\nCOMMANDS:\n   buf                      install buf on local machine\n   cfssl                    install cfssl on local machine\n   cfssljson                install cfssljson on local machine\n   gocov                    install gocov on local machine\n   golangci-lint            install golangci-lint on local machine\n   mockgen                  install mockgen on local machine\n   pkger                    install pkger on local machine\n   protobuf                 install protobuf on local machine\n   protoc-gen-doc           install protoc-gen-doc on local machine\n   protoc-gen-go            install protoc-gen-go on local machine\n   protoc-gen-go-grpc       install protoc-gen-go-grpc on local machine\n   protoc-gen-grpc-gateway  install protoc-gen-grpc-gateway on local machine\n   protoc-gen-openapiv2     install protoc-gen-openapiv2 on local machine\n   swag                     install swag on local machine\n   rk-std                   install rk standard environment on local machine\n   help, h                  Shows a list of commands or help for one command\n\n```\n\n### rk uninstall\n```shell script\nrk uninstall \n```\n\nSubcommands\n```shell script\nCOMMANDS:\n   buf                      uninstall buf from local machine\n   cfssl                    uninstall cfssl from local machine\n   cfssljson                uninstall cfssljson from local machine\n   gocov                    uninstall gocov from local machine\n   golangci-lint            uninstall golangci-lint from local machine\n   mockgen                  uninstall mockgen from local machine\n   pkger                    uninstall pkger from local machine\n   protobuf                 uninstall protobuf from local machine\n   protoc-gen-doc           uninstall protoc-gen-doc from local machine\n   protoc-gen-go            uninstall protoc-gen-go from local machine\n   protoc-gen-go-grpc       uninstall protoc-gen-go-grpc from local machine\n   protoc-gen-grpc-gateway  uninstall protoc-gen-grpc-gateway from local machine\n   protoc-gen-openapiv2     uninstall protoc-gen-openapiv2 from local machine\n   swag                     uninstall swag from local machine\n   rk-std                   uninstall rk standard environment on local machine\n   help, h                  Shows a list of commands or help for one command\n```\n\n### rk ut\n```shell script\nrk ut # Run unit test\n```\n\nSubcommands\n```shell script\nCOMMANDS:\n   help, h  Shows a list of commands or help for one command\n```\n\n### rk build\n```shell script\nrk build - Build project which contains build.yaml\n```\n\n### rk clear\n```shell script\nrk clear - Clear target folder generated by rk build\n```\n\n### rk pack\n```shell script\nrk pack - Pack target folder generated by rk build\n```\n\n### rk docker\n```shell script\nrk docker - Build a docker image built with rk build command\n```\n\nSubcommands\n```shell script\nCOMMANDS:\n   build    build a docker image built with rk build command\n   run      run a docker image built with rk docker build\n   help, h  Shows a list of commands or help for one command\n```\n\n### rk run\n```shell script\nrk run - run server build by rk build\n```\n\n## build.yaml\nBellow commands need to build project as RK style first in order to continue.\n- rk build\n- rk run\n- rk pack\n- rk docker build\n- rk docker run\n\n### Example\n```yaml\n---\nbuild:\n  type: go                          # Optional, default:go\n  main: \"internal/main.go\"          # Optional, default: ./main.go\n  GOOS: \"\"                          # Optional, default: current OS\n  GOARCH: \"\"                        # Optional, default: current Arch\n  args: \"\"                          # Optional, default: \"\", arguments which will attached to [go build] command\n  copy: [\"\"]                        # Optional, default: [], directories or files need to copy to [target] folder\n  commands:                         \n    before: []                      # Optional, default: [], commands would be invoked before [go build] command locally\n    after: []                       # Optional, default: [], commands would be invoked after [go build] command locally\n  scripts:\n    before: []                      # Optional, default: [], scripts would be executed before [go build] command locally\n    after: []                       # Optional, default: [], scripts would be executed after [go build] command locally\ndocker:\n  build:\n    registry: \"\"                    # Optional, default: [package name]\n    tag: \"\"                         # Optional, default: [current git tag or branch-latestCommit]\n    args: [\"\"]                      # Optional, default: \"\", docker args which will be attached to [docker build] command\n  run:\n    args: [\"-p\", \"8080:8080\"]       # Optional, default: \"\", docker args which will be attached to [docker run] command\n```\n\n## Development Status: Stable\n\n## Contributing\nWe encourage and support an active, healthy community of contributors \u0026mdash;\nincluding you! Details are in the [contribution guide](CONTRIBUTING.md) and\nthe [code of conduct](CODE_OF_CONDUCT.md). The rk maintainers keep an eye on\nissues and pull requests, but you can also report any negative conduct to\nlark@rkdev.info.\n\nReleased under the [Apache 2.0 License](LICENSE).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frookie-ninja%2Frk","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frookie-ninja%2Frk","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frookie-ninja%2Frk/lists"}