{"id":33966274,"url":"https://github.com/spinupwp/spinupwp-cli","last_synced_at":"2025-12-12T23:05:57.681Z","repository":{"id":38303492,"uuid":"400504807","full_name":"spinupwp/spinupwp-cli","owner":"spinupwp","description":"The official command-line tool for SpinupWP. ","archived":false,"fork":false,"pushed_at":"2025-11-18T17:08:03.000Z","size":32532,"stargazers_count":11,"open_issues_count":12,"forks_count":1,"subscribers_count":6,"default_branch":"main","last_synced_at":"2025-11-18T17:22:24.909Z","etag":null,"topics":["cli","php","spinupwp"],"latest_commit_sha":null,"homepage":"https://spinupwp.com","language":"PHP","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/spinupwp.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":null,"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,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2021-08-27T12:40:01.000Z","updated_at":"2025-11-18T17:08:07.000Z","dependencies_parsed_at":"2025-05-30T17:58:25.683Z","dependency_job_id":"53f4e5c0-157d-492b-8de1-dc14808f81b6","html_url":"https://github.com/spinupwp/spinupwp-cli","commit_stats":null,"previous_names":[],"tags_count":10,"template":false,"template_full_name":null,"purl":"pkg:github/spinupwp/spinupwp-cli","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/spinupwp%2Fspinupwp-cli","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/spinupwp%2Fspinupwp-cli/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/spinupwp%2Fspinupwp-cli/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/spinupwp%2Fspinupwp-cli/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/spinupwp","download_url":"https://codeload.github.com/spinupwp/spinupwp-cli/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/spinupwp%2Fspinupwp-cli/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":27694488,"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","status":"online","status_checked_at":"2025-12-12T02:00:06.775Z","response_time":129,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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","php","spinupwp"],"created_at":"2025-12-12T23:05:56.146Z","updated_at":"2025-12-12T23:05:57.673Z","avatar_url":"https://github.com/spinupwp.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"# SpinupWP CLI\n\n[![Tests](https://github.com/spinupwp/spinupwp-cli/actions/workflows/tests.yml/badge.svg?event=push)](https://github.com/spinupwp/spinupwp-cli/actions/workflows/tests.yml)\n[![Total Downloads](https://img.shields.io/packagist/dt/spinupwp/spinupwp-cli)](https://packagist.org/packages/spinupwp/spinupwp-cli)\n[![Latest Stable Version](https://img.shields.io/packagist/v/spinupwp/spinupwp-cli)](https://packagist.org/packages/spinupwp/spinupwp-cli)\n[![License](https://img.shields.io/packagist/l/spinupwp/spinupwp-cli)](https://packagist.org/packages/spinupwp/spinupwp-cli)\n\n\u003c!-- Everything below this uses very basic Markdown formatting because all updates need to be copied over to the doc at https://spinupwp.com/doc/cli/ --\u003e\n\n## Installation\n\nTo get started, require the package globally via [Composer](https://getcomposer.org):\n\n    composer global require spinupwp/spinupwp-cli\n\nIn addition, you should make sure the `/vendor/bin` directory in your global Composer home directory is in your system's \"PATH\". Depending on your operating system this could be either `~/.composer/` or `~/.config/composer/`. You can use the `composer config --global home` command to check this location.\n\n## Usage\n\nInstalling the SpinupWP CLI provides access to the `spinupwp` command.\n\n    spinupwp \u003ccommand\u003e\n\nYou will need to generate an API token to interact with the SpinupWP CLI. After you have generated an API token, you should configure your default profile:\n\n    spinupwp configure\n\nYou can configure multiple profiles, which is useful if you're a member of multiple teams:\n\n    spinupwp configure --profile=hellfishmedia\n\nTo run a command using a specific profile, pass the profile option:\n\n    spinupwp servers:list --profile=hellfishmedia\n\nIf no profile is supplied, your default profile will be used (if configured).\n\n### Servers\n\n    # Delete a server\n    spinupwp servers:delete \u003cserver_id\u003e\n\n    # Provision a custom server\n    spinupwp servers:create-custom\n\n    # Get a server\n    spinupwp servers:get \u003cserver_id\u003e --fields=id,name,ip_address,ubuntu_version,database.server\n\n    # List all servers\n    spinupwp servers:list --fields=id,name,ip_address,ubuntu_version,database.server\n\n    # Reboot a server\n    spinupwp servers:reboot \u003cserver_id\u003e\n\n    # Reboot all servers\n    spinupwp servers:reboot --all\n\n    # Start an SSH session\n    spinupwp servers:ssh \u003cserver_id\u003e \u003cuser\u003e\n\nYou can pass any properties of the [Server Schema](https://api.spinupwp.com/?shell#tocS_Server) to the `--fields` flag.\nNested properties should use dot notation, for example, `database.server`.\n\n### Services\n\n    # Restart MySQL on a server\n    spinupwp services:mysql \u003cserver_id\u003e\n\n    # Restart MySQL on all servers\n    spinupwp services:mysql --all\n\n    # Restart Nginx on a server\n    spinupwp services:nginx \u003cserver_id\u003e\n\n    # Restart Nginx on all servers\n    spinupwp services:nginx --all\n\n    # Restart PHP on a server\n    spinupwp services:php \u003cserver_id\u003e\n\n    # Restart PHP on all servers\n    spinupwp services:php --all\n\n    # Restart Redis on a server\n    spinupwp services:redis \u003cserver_id\u003e\n\n    # Restart Redis on all servers\n    spinupwp services:redis --all\n\n### Sites\n\n    # Create a site\n    spinupwp sites:create \u003cserver_id\u003e\n\n    # Delete a site\n    spinupwp sites:delete \u003csite_id\u003e\n\n    # Run a Git deployment\n    spinupwp sites:deploy \u003csite_id\u003e\n\n    # Get a site\n    spinupwp sites:get \u003csite_id\u003e --fields=id,server_id,domain,site_user,php_version,page_cache,https\n\n    # List all sites\n    spinupwp sites:list --fields=id,server_id,domain,site_user,php_version,page_cache,https\n\n    # Purge the page cache for a site\n    spinupwp sites:purge \u003csite_id\u003e --cache=page\n\n    # Purge the page cache for all sites\n    spinupwp sites:purge --all --cache=page\n\n    # Purge the object cache for a site\n    spinupwp sites:purge \u003csite_id\u003e --cache=object\n\n    # Purge the object cache for all sites\n    spinupwp sites:purge --all --cache=object\n\n    # Start an SSH session as the site user\n    spinupwp sites:ssh \u003csite_id\u003e\n\nYou can pass any properties of the [Site Schema](https://api.spinupwp.com/?shell#tocS_Site) to the `--fields` flag.\nNested properties should use dot notation, for example, `backups.next_run_time` or `git.branch`.\n\n\n    # Create a site using field flags instead of interactive prompts\n    spinupwp sites:create \u003cserver_id\u003e --installation-method=\"\u003cinstallation_method\u003e\" \\\n      --domain=\"\u003cdomain\u003e\" --https-enabled --site-user=\"\u003csite_user\u003e\" --db-name=\"\u003cdatabase_name\u003e\" \\\n      --db-user=\"\u003cdatabase_user\u003e\" --db-pass=\"\u003cdatabase_password\u003e\" --wp-title=\"\u003cwordpress_site_title\u003e\" \\\n      --wp-admin-email=\"\u003cwordpress_admin_user_email\u003e\" --wp-admin-user=\"\u003cwordpress_admin_user_username\u003e\" \\\n      --wp-admin-pass=\"\u003cwordpress_admin_user_password\u003e\" --php-version=\"\u003cphp_version\u003e\" --page-cache-enabled\n\nA full reference of the available flags is available anytime.\n\n    # Display available Arguments and Options for site:create \n    spinupwp sites:create --help\n\n## Upgrade\n\nTo update the SpinupWP CLI to the latest version, run:\n\n    composer global update\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fspinupwp%2Fspinupwp-cli","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fspinupwp%2Fspinupwp-cli","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fspinupwp%2Fspinupwp-cli/lists"}