{"id":13607385,"url":"https://github.com/wintercms/cli","last_synced_at":"2025-05-13T16:31:56.592Z","repository":{"id":42636974,"uuid":"292533670","full_name":"wintercms/cli","owner":"wintercms","description":"A command-line helper for managing Winter CMS installations.","archived":false,"fork":false,"pushed_at":"2023-01-30T01:28:47.000Z","size":2914,"stargazers_count":7,"open_issues_count":4,"forks_count":2,"subscribers_count":5,"default_branch":"main","last_synced_at":"2024-04-14T00:37:56.924Z","etag":null,"topics":["hacktoberfest"],"latest_commit_sha":null,"homepage":"","language":"PHP","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/wintercms.png","metadata":{"funding":{"github":"wintercms","open_collective":"wintercms"},"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2020-09-03T10:07:27.000Z","updated_at":"2023-09-15T14:56:31.000Z","dependencies_parsed_at":"2023-01-17T21:02:22.571Z","dependency_job_id":null,"html_url":"https://github.com/wintercms/cli","commit_stats":{"total_commits":60,"total_committers":2,"mean_commits":30.0,"dds":0.01666666666666672,"last_synced_commit":"4700346745a3b651e6f047ddddf42f02ba583798"},"previous_names":[],"tags_count":10,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wintercms%2Fcli","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wintercms%2Fcli/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wintercms%2Fcli/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wintercms%2Fcli/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/wintercms","download_url":"https://codeload.github.com/wintercms/cli/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":225076967,"owners_count":17417163,"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":["hacktoberfest"],"created_at":"2024-08-01T19:01:18.153Z","updated_at":"2024-11-18T20:28:36.022Z","avatar_url":"https://github.com/wintercms.png","language":"PHP","funding_links":["https://github.com/sponsors/wintercms","https://opencollective.com/wintercms"],"categories":["Uncategorized"],"sub_categories":["Uncategorized"],"readme":"# Winter CMS CLI Helper\n\nA command line tool to help users manage Winter CMS installations.\n\n```\nUsage:\n  command [options] [arguments]\n\nOptions:\n  -h, --help            Display this help message\n  -q, --quiet           Do not output any message\n  -V, --version         Display this application version\n      --ansi            Force ANSI output\n      --no-ansi         Disable ANSI output\n  -n, --no-interaction  Do not ask any interactive question\n  -v|vv|vvv, --verbose  Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug\n\nAvailable commands:\n  help             Displays help for a command\n  list             Lists commands\n  self-update      [selfupdate] Self-updates the Winter CLI helper.\n github\n  github:token     Sets the GitHub Access token for the helper.\n install\n  install:check    Checks the current environment that it can run Winter CMS.\n project\n  project:alerts   View security alerts for an Winter CMS project.\n  project:version  Determines the version of Winter CMS in use in a project.\n```\n\n## Installation\n\nYou can download the latest PHAR release of this tool from the [Releases](https://github.com/wintercms/cli/releases) page. Download this file to your preferred location, then make the PHAR file executable (optionally, renaming it to `winter` if you wish):\n\n```\nmv winter.phar winter\nchmod a+x winter\n```\n\nMove this file into one of your `$PATH` directories to make this CLI helper available globally.\n\n```\nmv winter /usr/bin/winter\n```\n\n## Other Requirements\n\nSome commands (such as the `project:alerts` command) use the GitHub API, and may not be accessible due to rate limits imposed by GitHub. To work around this, you can create an Access Token in your GitHub account and store this with the CLI helper for future use.\n\nYou can create the necessary token by going to the following URL:\nhttps://github.com/settings/tokens/new?scopes=public_repo\u0026description=Winter%20CMS%20CLI%20Helper\n\nOnce done, you can then use the `winter github:token` command, adding the token as an argument, to store the token and allow the CLI helper to use your token for future API calls.\n\n## Usage\n\nRun the tool by running `winter` (or `winter.phar`). By default, it will show the help screen with command line options and available commands. You can also add the `--help` option after any command to get help on specific commands.\n\n## Commands\n\n### `self-update`\n\n```\nwinter self-update\nwinter selfupdate\n```\n\nThis will update the Winter CLI helper to the latest version, if not already installed.\n\n### `github:token`\n\n```\nwinter github:token [token]\n```\n\nRegisters a GitHub Access Token which is used for some commands that use the GitHub API and may be subject to rate limits from GitHub (such as the `project:alerts` command). This will be stored in the user's home directory for future use.\n\n### `install:check`\n\n```\nwinter install:check\n```\n\nThis command allows you to check that your current environment can run Winter CMS.\n\nThe command checks that your PHP version is compatible, ensures that the necessary extensions are installed and that configuration settings for PHP are correctly set. If any requirements are not met, the command will give you suggestions on the necessary steps to take in order to make your environment compatible for Winter CMS.\n\n### `project:alerts`\n\n```\nwinter project:alerts [path]\n```\n\nThis will compare the installed version of Winter CMS against the [database of security advisories](https://github.com/wintercms/winter/security/advisories) published by the Winter CMS maintainers, and will indicate whether your Winter CMS instance needs to be updated or not.\n\n### `project:version`\n\n```\nwinter project:version [-d|--detailed] [path]\n```\n\nThis will detect the installed version of Winter CMS in the given path. The path is optional - if not provided, it will look in the current work directory.\n\nThe optional `-d|--detailed` option will also print out a list of modified, created or deleted files in the Winter CMS installation, if any changes have been made to the core Winter CMS files.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwintercms%2Fcli","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fwintercms%2Fcli","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwintercms%2Fcli/lists"}