{"id":26493984,"url":"https://github.com/dwarvesf/miner-go","last_synced_at":"2025-03-20T09:58:29.957Z","repository":{"id":87035856,"uuid":"93996093","full_name":"dwarvesf/miner-go","owner":"dwarvesf","description":"The mining assistant of Dwarves Foundation","archived":false,"fork":false,"pushed_at":"2017-09-29T10:31:00.000Z","size":18,"stargazers_count":0,"open_issues_count":1,"forks_count":0,"subscribers_count":3,"default_branch":"master","last_synced_at":"2024-08-21T12:50:46.506Z","etag":null,"topics":["cli","dwarvesf","golang","operation"],"latest_commit_sha":null,"homepage":null,"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/dwarvesf.png","metadata":{"files":{"readme":"README.md","changelog":null,"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":"2017-06-11T10:03:50.000Z","updated_at":"2024-08-21T12:50:48.720Z","dependencies_parsed_at":null,"dependency_job_id":"f343d470-dbe0-4116-aa49-fc59ab6aafaa","html_url":"https://github.com/dwarvesf/miner-go","commit_stats":null,"previous_names":["dwarvesf/miner"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dwarvesf%2Fminer-go","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dwarvesf%2Fminer-go/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dwarvesf%2Fminer-go/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dwarvesf%2Fminer-go/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/dwarvesf","download_url":"https://codeload.github.com/dwarvesf/miner-go/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244591451,"owners_count":20477709,"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","dwarvesf","golang","operation"],"created_at":"2025-03-20T09:58:29.432Z","updated_at":"2025-03-20T09:58:29.949Z","avatar_url":"https://github.com/dwarvesf.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# miner\nThe mining assistant of Dwarves Foundation\n\n## Prerequisite\n\nGo installed: https://github.com/dwarvesf/setup-backend#install-go\n\n## Install\n\n```\n$ go get https://github.com/dwarvesf/miner\n```\n\n# Usage\n\n## Help\n\n```\n$ miner\n$ miner -h\n\n// To view usage of specific sub-command\n$ miner \u003ccommand\u003e\n```\n\n## Dotfiles\n\nPull and setup dotfiles from [**dwarvesf/dotfiles**](https://github.com/dwarvesf/dotfiles)\n\n### Init dotfiles\n\nSetup dotfiles from scratch. File `.dfrc` will be created \n\n```\n$ miner dotfiles init\n```\n\nThe command will fail if `.dfrc` is already existed\n\n### Backup your dotfiles\n\nBundle your `.dfrc`, dotfiles including your customized configuration. \n\n```\n$ miner dotfiles backup --out minerc.zip\n```\n\n### Restore dotfiles\n\nRestore your dotfiles from the backup file. This command requires input bundle. \n\n```\n$ miner dotfiles restore --in minerc.zip\n```\n\n### Update\n\nUpdate dotfiles to latest version but still keep your custom config\n\n```\n$ miner dotfiles update\n```\n\n### Clean up\n\n```\n$ miner dotfiles clean\n```\n\n## Project\n\nThis requires a self-hosted [Dashboard from Dwarves Foundation](https://github.com/dwarvesf/fortress) to manage all the projects and team information\n\n### Config\n\nYou need to retrieve below environment var from the dashboard\n\n- URL\n- API Token\n\n```\n$ miner config set URL=https://fortress.dwarvesf.com\n$ miner config set API=\u003creally long string\u003e\n```\n\n### Init\n\nIt will help to create project artifacts\n\n- Gitlab group and repos with git template\n- Trello board\n- Slack channel\n\n```\n$ miner project new --name=\u003cname\u003e --config=\u003cconfig.yml\u003e\n```\n\n### New invoice\n\nPrepare invoice of input stage for indicated project\n\n```\n$ miner project.invoice \n```\n\n## Misc\n\nThis requires a self-hosted [Dashboard from Dwarves Foundation](https://github.com/dwarvesf/fortress)\n\n### Email\n\nThe command will help to send email with predefined template from the Dashboard\n\n- National Holiday\n- Accept (or reject) candidate\n- Setup meeting and workflow with customer\n\n```\n$ miner email holiday\n```\n\n## Contributing\n\nThe main purpose of this repository is to continue to evolve the way we setup development environment, making it faster and easier to use. Development happens in the open on GitHub, and we are grateful to the community for contributing bugfixes and improvements. Read below to learn how you can take part in improving it.\n\n### Contributing Guide\n\nRead our contributing guide to learn about our development process, how to propose bugfixes and improvements, and how to build and test your changes.\n\n## License\n\nCopyright 2017 Dwarves Foundation\n\nLicensed under the Apache License, Version 2.0 (the \"License\"); you may not use this file except in compliance with the License. You may obtain a copy of the License at\n\nhttp://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software distributed under the License is distributed on an \"AS IS\" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdwarvesf%2Fminer-go","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdwarvesf%2Fminer-go","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdwarvesf%2Fminer-go/lists"}