{"id":17355119,"url":"https://github.com/zephinzer/zscripts","last_synced_at":"2025-06-17T10:04:25.768Z","repository":{"id":57406677,"uuid":"131480989","full_name":"zephinzer/zscripts","owner":"zephinzer","description":"A set of utility scripts for ease of development work.","archived":false,"fork":false,"pushed_at":"2018-05-28T11:02:38.000Z","size":53,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-03-18T16:57:01.221Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"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/zephinzer.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}},"created_at":"2018-04-29T09:17:59.000Z","updated_at":"2018-05-28T11:02:39.000Z","dependencies_parsed_at":"2022-09-05T06:41:42.581Z","dependency_job_id":null,"html_url":"https://github.com/zephinzer/zscripts","commit_stats":null,"previous_names":[],"tags_count":13,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zephinzer%2Fzscripts","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zephinzer%2Fzscripts/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zephinzer%2Fzscripts/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zephinzer%2Fzscripts/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/zephinzer","download_url":"https://codeload.github.com/zephinzer/zscripts/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245858880,"owners_count":20684062,"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-15T17:42:22.807Z","updated_at":"2025-03-27T14:17:01.077Z","avatar_url":"https://github.com/zephinzer.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# ZScripts\nA set of utility scripts for ease of development work.\n\n## Installation\nThis package is available on `npm` repository. Install it locally or globally:\n\n```sh\nnpm i zscripts\n# or globally:\nnpm i -g zscripts\n```\n\nThis will create a `zsc` command.\n\n## Usage\nTo invoke it, use:\n\n```sh\nzsc [command] [options]\n```\n\n## Commands\n- [`npm`](#npm-command)\n- [`publish`](#publish-command)\n- [`up`](#up-command)\n- [`version'](#verison-command)\n\n### Npm Command\n\n#### Version\n\n```sh\nzsc npm version|v [...options]\n```\n\n##### Options\n\n`-p, --patch`: Updates the patch version\n\n`-m, --minor`: Updates the minor version\n\n`-M, --major`: Updates the major version\n\n\u003e If no options are specified, defaults to patch.\n\n### Publish Command\n\n#### NPM\nPublishes the current repository to NPM, using the Git tags' semantic versioning tags as the version in the `package.json`.\n\n##### `zsc publish npm` Options\n\n`-p, --private`: Sets the flag to release the package as private\n\n`-y, --auto`: Publishes the package without confirmation\n\n### Up Command\n\n#### `zsc up` Options\nAll subcommands in the `up` command take in the following option flags:\n\n`-P, --host-port [host-port]`: Specifies the host port for accessing the primary service, this usually defaults to the service's native port\n\n`-l, --link [existing:in-app]`: Links containers to container being spun up\n\n`-n, --name [name]`: Specifies the name of the container\n\n`-U, --user-id [user-id]`: Specifies the user ID for the sonarqube instance\n\n#### MySQL\nCreates a local instance of MySQL.\n\n```sh\nzsc up mysql [...options]\n```\n\n\u003e Default port: 3306\n\n##### `zsc up mysql` Options\n\n`-u, --username`: Specifies the username. Defaults to `\"username\"` when not defined.\n\n`-p, --password`: Specifies the password for the user specified in `--username`. This is also used for the root password. Defaults to `\"password\"` when not defined.\n\n#### Prometheus\nCreates a local instance of Prometheus.\n\n```sh\nzsc up prometheus [...options]\n```\n\n\u003e Default port: 9090\n\n##### `zsc up prometheus` Options\n\n`-c, --config-file-path`: Specifies a local absolute path to a configuration file for Prometheus to use. Defaults to `null` which means the Prometheus image uses the default file at `/etc/prometheus/prometheus.yml`\n\n#### Redis\nCreates a local instance of Redis.\n\n```sh\nzsc up redis [...options]\n```\n\n\u003e Default port: 6379\n\n##### `zsc up redis` Options\n\nNone.\n\n#### Sonarqube\nCreates a local instance of Sonarqube.\n\n```sh\nzsc up sonarqube [...options]\n```\n\n\u003e Default port: 9000\n\n##### `zsc up sonarqube` Options\n\n`-Pdb, --host-port-db`: Specifies the port which will be host can expect to find the Sonarqube database. Defaults to `9092`.\n\n### `version` Command\nThe `zsc version [...subcommand] [...options]` commands use Git tags to manage the version of a repository.\n\n#### Version Bump\nBumps the version for the Git repository. Run this from inside any Git repository.\n\n```sh\nzsc version bump [...options]\n```\n\n##### `zsc version bump` Options\n\n`-a, --alpha`: Does an alpha release (applicable only for pre-release version bumps)\n\n`-b, --beta`: Does a beta release (applicable only for pre-release version bumps)\n\n`-c, --release-candidate`: Does a release candidate release (applicable only for pre-release version bumps)\n\n`-r, --pre-release`: Performs a pre-release version bump\n\n`-o, --pre-patch [pre-patch-id]`: Performs a pre-patch version bump\n\n`-p, --patch`: Performs a patch version bump\n\n`-l, --pre-minor [pre-minor-id]`: Performs a pre-minor version bump\n\n`-m, --minor`: Performs a minor version bump\n\n`-L, --pre-major [pre-major-id]`: Performs a pre-major version bump\n\n`-M, --major`: Performs a major version bump\n\n#### Version Current\nOutputs the current version according to the Git tags.\n\n##### `zsc version current` Options\n\nNone.\n\n#### Version Next\nOutputs the next version according to the Git tags.\n\n##### `zsc version next` Options\n\n`-a, --alpha`: Does an alpha release (applicable only for pre-release version bumps)\n\n`-b, --beta`: Does a beta release (applicable only for pre-release version bumps)\n\n`-c, --release-candidate`: Does a release candidate release (applicable only for pre-release version bumps)\n\n`-r, --pre-release`: Performs a pre-release version bump\n\n`-o, --pre-patch [pre-patch-id]`: Performs a pre-patch version bump\n\n`-p, --patch`: Performs a patch version bump\n\n`-l, --pre-minor [pre-minor-id]`: Performs a pre-minor version bump\n\n`-m, --minor`: Performs a minor version bump\n\n`-L, --pre-major [pre-major-id]`: Performs a pre-major version bump\n\n`-M, --major`: Performs a major version bump\n\n#### Version Init\nInitialises version for the Git repository at `0.0.0`. Run this from inside any Git repository.\n\n```sh\nzsc version init\n```\n\n##### `zsc version init` Options\n\nNone.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzephinzer%2Fzscripts","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fzephinzer%2Fzscripts","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzephinzer%2Fzscripts/lists"}