{"id":16843888,"url":"https://github.com/sbfaulkner/dev-plugin-zsh","last_synced_at":"2025-04-11T05:53:32.192Z","repository":{"id":55115396,"uuid":"328053742","full_name":"sbfaulkner/dev-plugin-zsh","owner":"sbfaulkner","description":"zsh plug-in to automate project setup and workflow","archived":false,"fork":false,"pushed_at":"2021-12-30T17:36:26.000Z","size":68,"stargazers_count":5,"open_issues_count":0,"forks_count":1,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-04-11T05:53:26.581Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Shell","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/sbfaulkner.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2021-01-09T01:56:28.000Z","updated_at":"2024-05-27T10:50:30.000Z","dependencies_parsed_at":"2022-08-14T12:30:39.750Z","dependency_job_id":null,"html_url":"https://github.com/sbfaulkner/dev-plugin-zsh","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/sbfaulkner%2Fdev-plugin-zsh","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sbfaulkner%2Fdev-plugin-zsh/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sbfaulkner%2Fdev-plugin-zsh/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sbfaulkner%2Fdev-plugin-zsh/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/sbfaulkner","download_url":"https://codeload.github.com/sbfaulkner/dev-plugin-zsh/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248351405,"owners_count":21089271,"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-10-13T12:54:04.746Z","updated_at":"2025-04-11T05:53:32.169Z","avatar_url":"https://github.com/sbfaulkner.png","language":"Shell","funding_links":[],"categories":["Plugins"],"sub_categories":["ZSH on Windows"],"readme":"# dev plugin\n\nThis plugin provides a lightweight version of [Shopify's internal dev tool](https://devproductivity.io/dev-shopifys-all-purpose-development-tool/index.html).\n\n## Commands\n\n* `clone` \u003crepo\u003e    - Clone a repo from GitHub.\n* `open` \u003ctarget\u003e   - Open a target in your browser.\n* `up`              - Install and start any dependencies.\n\n### Open\n\nTargets for the open command include:\n\n* `gh`      - Open the repo on GitHub.\n* `pr`      - Open the PR on GitHub.\n\n### Up\n\nDependencies to be installed or started are identified in a `dev.yml` file under the top-level `up` key.\n\nFor example:\n\n```\nup:\n  - homebrew:\n    - mysql-client\n  - ruby: 2.7.1\n  - bundler\n```\n\nSupported dependencies include:\n\n* `bundler`     - Ruby gems will be installed via [Bundler](https://bundler.io).\n* `go`          - The version of [Go](https://golang.org) to be installed via [TBD]().\n* `homebrew`    - A list of packages to be installed via [Homebrew](https://brew.sh).\n* `ruby`        - The version of [Ruby](http://www.ruby-lang.org) to be installed and used via [ruby-install](https://github.com/postmodern/ruby-install#readme) and [chruby](https://github.com/postmodern/chruby/#readme).\n\n## Custom Commands\n\nProject-specific commands are defined via a `dev.yml` file in the current directory or a parent of that directory. Commands are defined with their names as keys under the top-level `commands` key.\n\nFor example:\n\n```\ncommands:\n  style:\n    ...\n  build:\n    ...\n  test:\n    ...\n```\n\n### Command Definitions\n\nA command's properties are defined as a set of key-value pairs. The supported properties are:\n\n* `run`     - A shell command to be run when the command is invoked (required).\n* `desc`    - A description of the command (optional).\n* `aliases` - A set of aliases which can be used to invoke the command (optional).\n\nFor example:\n\n```\ncommands:\n  style:\n    desc: Check style of source files.\n    run: bundle exec rubocop -D\n    aliases: ['lint']\n```\n\nIn place of the set of properties, a simple string value may be used as a short-form notation to define the shell command to be run.\n\nFor example:\n\n```\ncommands:\n  test: go test ./...\n```\n\n### Running Commands\n\nProject-specific commands are invoked the same way built-in commands are run.\n\nFor example:\n\n```\n$ dev test -short\n```\n\nWhen running the script any additional parameters passeed on the command line will be appended to end of the command. An explicit `$@` or `$*` will override this behaviour when present within the shell command.\n\n## Installation\n\nThe [GitHub CLI](https://cli.github.com) needs to be installed in order to support integration with GitHub.\n\n[ruby-install](https://github.com/postmodern/ruby-install#readme) is required to install [Ruby](http://www.ruby-lang.org).\n\n[chruby](https://github.com/postmodern/chruby/#readme) is needed in order to select the current [Ruby](http://www.ruby-lang.org) version.\n\n[chgo-plugin-zsh](https://github.com/sbfaulkner/chgo-plugin-zsh/#readme) is needed in order to select the current [Go](https://golang.org) version.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsbfaulkner%2Fdev-plugin-zsh","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsbfaulkner%2Fdev-plugin-zsh","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsbfaulkner%2Fdev-plugin-zsh/lists"}