{"id":13731942,"url":"https://github.com/wordup-dev/wordup-cli","last_synced_at":"2025-09-29T20:31:01.229Z","repository":{"id":47438970,"uuid":"183462404","full_name":"wordup-dev/wordup-cli","owner":"wordup-dev","description":"Wordup is a fully integrated development platform for WordPress. Develop plugins and themes locally. Preview in the cloud. Automatic updates in WP.","archived":true,"fork":false,"pushed_at":"2021-11-27T10:26:14.000Z","size":1145,"stargazers_count":116,"open_issues_count":34,"forks_count":16,"subscribers_count":4,"default_branch":"master","last_synced_at":"2024-12-16T11:05:12.081Z","etag":null,"topics":["cli","developer-tools","docker","docker-compose","nodejs","npm-package","php","web","wordpress","wordpress-development","wp-cli"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/wordup-dev.png","metadata":{"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}},"created_at":"2019-04-25T15:32:49.000Z","updated_at":"2024-12-12T23:18:15.000Z","dependencies_parsed_at":"2022-09-15T15:00:42.685Z","dependency_job_id":null,"html_url":"https://github.com/wordup-dev/wordup-cli","commit_stats":null,"previous_names":[],"tags_count":31,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wordup-dev%2Fwordup-cli","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wordup-dev%2Fwordup-cli/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wordup-dev%2Fwordup-cli/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wordup-dev%2Fwordup-cli/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/wordup-dev","download_url":"https://codeload.github.com/wordup-dev/wordup-cli/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":234659852,"owners_count":18867628,"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","developer-tools","docker","docker-compose","nodejs","npm-package","php","web","wordpress","wordpress-development","wp-cli"],"created_at":"2024-08-03T02:01:42.042Z","updated_at":"2025-09-29T20:30:55.911Z","avatar_url":"https://github.com/wordup-dev.png","language":"JavaScript","readme":"Wordup CLI\n==========\n\n\u003e ⚠️**CAUTION**: This package is unmaintained\n\n[![Version](https://img.shields.io/npm/v/wordup-cli.svg)](https://npmjs.org/package/wordup-cli)\n[![Downloads/week](https://img.shields.io/npm/dw/wordup-cli.svg)](https://npmjs.org/package/wordup-cli)\n[![Twitter Follow](https://img.shields.io/twitter/follow/wordup_dev.svg?label=%40wordup_dev\u0026style=social)](https://twitter.com/wordup_dev)\n\n\nWordup CLI is an open-source development toolkit for setting up and managing your local WordPress Theme/Plugin development, so that you can totally focus on coding.\n\nIt is based on docker-compose and uses a docker containerized LAMP-stack with all WordPress Plugins/Themes you need for your current project.\n\n\u003c!-- toc --\u003e\n* [Features](#features)\n* [Installation / Requirements](#installation--requirements)\n* [Documentation](#documentation)\n* [Usage](#usage)\n* [Commands](#commands)\n* [Wordup for Visual Studio Code](#wordup-for-visual-studio-code)\n* [License / Contributing](#license--contributing)\n\u003c!-- tocstop --\u003e\n\n# Features\n\nWhat you can do with wordup-cli:\n\n* 💡**Rapidly test new ideas** - And develop your new WordPress theme/plugin projects in wordup. \n* ⏱**Speed up your development** - Install a new project with a blank WordPress installation in a matter of minutes\n* 🛠️**Boilerplate** - Scaffold your theme/plugin with the official source code from WordPress (e.g. [underscore](https://github.com/automattic/_s)). You can also add code snippets like *Gutenberg* blocks to your source code.\n* ⚙️**Automatic installation of dependencies** - Automatically download and activate public WordPress Plugins/Themes or even Github hosted projects (like e.g. [wp-graphql](https://github.com/wp-graphql/wp-graphql))\n* 🚀**Easy portability** - Export your theme/project or your whole WordPress installation. So that you can install it on a remote server.\n* 📦**Backup your installation** - And (re)install a project from an exported wordup project.\n* 👾**Share your stack** - wordup is the easiest way to share your WordPress project with the world or just your team members. Just type:  `git clone`, and then `wordup install`\n* ✉️**Catch emails** - Catch all emails from WordPress and view the outgoing emails in a web UI\n\n# Installation / Requirements \n\nMake sure you have node \u003e= 8.3 (npm \u003e= 5.2) and [docker-compose](https://www.docker.com/get-started) installed on your machine. \n\nWe recommend to install wordup-cli **globally**: \n\n```sh\n$ npm install -g wordup-cli\n```\n\nAfter installing wordup-cli, you can create your first project with `wordup init`\n\n# Documentation\n\nFor detailed information visit [docs.wordup.dev](https://docs.wordup.dev)\n\n\n# Usage\n\u003c!-- usage --\u003e\n```sh-session\n$ npm install -g wordup-cli\n$ wordup COMMAND\nrunning command...\n$ wordup (-v|--version|version)\nwordup-cli/1.0.0 darwin-x64 node-v10.15.0\n$ wordup --help [COMMAND]\nUSAGE\n  $ wordup COMMAND\n...\n```\n\u003c!-- usagestop --\u003e\n# Commands\n\u003c!-- commands --\u003e\n* [`wordup cloud:auth`](#wordup-cloudauth)\n* [`wordup cloud:clone`](#wordup-cloudclone)\n* [`wordup cloud:project`](#wordup-cloudproject)\n* [`wordup cloud:publish`](#wordup-cloudpublish)\n* [`wordup export TYPE`](#wordup-export-type)\n* [`wordup help [COMMAND]`](#wordup-help-command)\n* [`wordup init`](#wordup-init)\n* [`wordup list`](#wordup-list)\n* [`wordup local:install`](#wordup-localinstall)\n* [`wordup local:start`](#wordup-localstart)\n* [`wordup local:stop`](#wordup-localstop)\n* [`wordup snippet TYPE NAME`](#wordup-snippet-type-name)\n* [`wordup wpcli [COMMAND]`](#wordup-wpcli-command)\n\n## `wordup cloud:auth`\n\nAuthenticate the CLI with your wordup account\n\n```\nUSAGE\n  $ wordup cloud:auth\n\nOPTIONS\n  -l, --logout  Logout of your account\n\nDESCRIPTION\n  ...\n  You will be redirect to the wordup.dev page.\n```\n\n_See code: [src/commands/cloud/auth.js](https://github.com/wordup-dev/wordup-cli/blob/v1.0.0/src/commands/cloud/auth.js)_\n\n## `wordup cloud:clone`\n\nClone current running WordPress installation to a new node in your wordup account\n\n```\nUSAGE\n  $ wordup cloud:clone\n\nDESCRIPTION\n  ...\n  This command will automatically backup and upload your running WordPress installation to wordup.\n\n  After cloning the project, your data will be deleted from our servers.\n```\n\n_See code: [src/commands/cloud/clone.js](https://github.com/wordup-dev/wordup-cli/blob/v1.0.0/src/commands/cloud/clone.js)_\n\n## `wordup cloud:project`\n\nCreate a new remote project on wordup.dev\n\n```\nUSAGE\n  $ wordup cloud:project\n\nOPTIONS\n  --public  Create a public project\n\nDESCRIPTION\n  ...\n  Use this function to create a remote project on wordup.dev from your local project config.\n```\n\n_See code: [src/commands/cloud/project.js](https://github.com/wordup-dev/wordup-cli/blob/v1.0.0/src/commands/cloud/project.js)_\n\n## `wordup cloud:publish`\n\nPublish your WordPress theme or plugin to your private theme/plugin directory on wordup.\n\n```\nUSAGE\n  $ wordup cloud:publish\n\nOPTIONS\n  --env=release|staging          (required) Specify the environment you want to publish to\n  --increment=major|minor|patch  [default: minor] Increment a version by the specified level\n  --token=token                  A provided project token\n\nDESCRIPTION\n  ...\n  The private directory on wordup manages your WordPress plugin and theme projects in the cloud.\n\n  After publishing the project, all WordPress installations can update your theme/plugin to the new project version.\n```\n\n_See code: [src/commands/cloud/publish.js](https://github.com/wordup-dev/wordup-cli/blob/v1.0.0/src/commands/cloud/publish.js)_\n\n## `wordup export TYPE`\n\nExport your plugin/theme or the whole WordPress installation\n\n```\nUSAGE\n  $ wordup export TYPE\n\nARGUMENTS\n  TYPE  (src|installation|sql) [default: src] What type do you want to export\n\nOPTIONS\n  --logs  Shows all stdout logs of this process\n\nDESCRIPTION\n  ...\n  The exported zip-file of a plugin/theme are ready for distribution.\n\n  An exported installation file can be used for setting up a remote WordPress installation or\n  for backing up your current development stack.\n```\n\n_See code: [src/commands/export.js](https://github.com/wordup-dev/wordup-cli/blob/v1.0.0/src/commands/export.js)_\n\n## `wordup help [COMMAND]`\n\ndisplay help for wordup\n\n```\nUSAGE\n  $ wordup help [COMMAND]\n\nARGUMENTS\n  COMMAND  command to show help for\n\nOPTIONS\n  --all  see all commands in CLI\n```\n\n_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v2.2.3/src/commands/help.ts)_\n\n## `wordup init`\n\nCreate a new wordup project in the current directoy\n\n```\nUSAGE\n  $ wordup init\n\nOPTIONS\n  --name=name                         A name for the new project\n  --type=plugins|themes|installation  What type of WordPress project\n\nDESCRIPTION\n  ...\n  After you have initialized a new project, you can start the docker development server with 'wordup local:install'\n```\n\n_See code: [src/commands/init.js](https://github.com/wordup-dev/wordup-cli/blob/v1.0.0/src/commands/init.js)_\n\n## `wordup list`\n\nList all executable wordup projects\n\n```\nUSAGE\n  $ wordup list\n\nOPTIONS\n  --clear  Clears the project list from non-existing projects\n\nDESCRIPTION\n  ...\n  If you see deleted projects in this list, run with --clear flag.\n\nALIASES\n  $ wordup ls\n```\n\n_See code: [src/commands/list.js](https://github.com/wordup-dev/wordup-cli/blob/v1.0.0/src/commands/list.js)_\n\n## `wordup local:install`\n\nInstall and start the WordPress development server\n\n```\nUSAGE\n  $ wordup local:install\n\nOPTIONS\n  -p, --port=port    [default: 8000] Install on a different port\n  --archive=archive  Install from a wordup archive (needs to be located in your dist folder).\n  --build            Build the WordPress docker container on your system\n  --logs             Shows all stdout logs of this process\n  --prompt           If you want to do the setup again\n\nDESCRIPTION\n  ...\n  If there is no wpInstall config in .wordup/config.yml, a setup for your installation will be shown.\n\n  The web frontend for the catched emails (MailHog) is available on localhost:[WORDPRESS_PORT + 1]\n\n  Wordup will assign automatically a different default port, if the default port of 8000 is taken by another wordup \n  project.\n\n  Note: Flags in this command overrule the wordup config.yml.\n\nALIASES\n  $ wordup install\n```\n\n_See code: [src/commands/local/install.js](https://github.com/wordup-dev/wordup-cli/blob/v1.0.0/src/commands/local/install.js)_\n\n## `wordup local:start`\n\nStart the WordPress development server\n\n```\nUSAGE\n  $ wordup local:start\n\nOPTIONS\n  --logs  Shows all stdout logs of this process\n\nDESCRIPTION\n  ...\n  You can onl run this command if your development stack is installed.\n\nALIASES\n  $ wordup run\n  $ wordup start\n```\n\n_See code: [src/commands/local/start.js](https://github.com/wordup-dev/wordup-cli/blob/v1.0.0/src/commands/local/start.js)_\n\n## `wordup local:stop`\n\nStop the development server\n\n```\nUSAGE\n  $ wordup local:stop\n\nOPTIONS\n  -d, --delete           Deletes all attached volumes/data (WARNING: Your content in your WordPress installation will be\n                         deleted)\n\n  -p, --project=project  A project slug name\n\n  --force                Force delete\n\n  --logs                 Shows all stdout logs of this process\n\nDESCRIPTION\n  ...\n  Optionally you can use -d to delete the whole installation, this includes all files in your WordPress installation.\n\nALIASES\n  $ wordup stop\n```\n\n_See code: [src/commands/local/stop.js](https://github.com/wordup-dev/wordup-cli/blob/v1.0.0/src/commands/local/stop.js)_\n\n## `wordup snippet TYPE NAME`\n\nAdd code snippets like Gutenberg blocks, custom post types or taxonomies to your code\n\n```\nUSAGE\n  $ wordup snippet TYPE NAME\n\nARGUMENTS\n  TYPE  (block|post-type|taxonomy) What type do you want to add to your project\n  NAME  Name of the element you want to add\n\nOPTIONS\n  --logs  Shows all stdout logs of this process\n\nDESCRIPTION\n  ...\n  This code snippets will be added to your current project source code. You can add as many as you want.\n  Just include the generated php file in your main project file.\n\n  As an example: wordup snippet block MyGutenbergBlock\n```\n\n_See code: [src/commands/snippet.js](https://github.com/wordup-dev/wordup-cli/blob/v1.0.0/src/commands/snippet.js)_\n\n## `wordup wpcli [COMMAND]`\n\nUse an official WordPress CLI command on the current running project\n\n```\nUSAGE\n  $ wordup wpcli [COMMAND]\n\nARGUMENTS\n  COMMAND  the wp cli command\n\nOPTIONS\n  --logs  Shows all stdout logs of this process\n\nDESCRIPTION\n  ...\n  As an example: wordup wpcli post list. \n\n  If you run wordup wpcli without any argument, you will directly access the command line of the underlying docker \n  container.\n```\n\n_See code: [src/commands/wpcli.js](https://github.com/wordup-dev/wordup-cli/blob/v1.0.0/src/commands/wpcli.js)_\n\u003c!-- commandsstop --\u003e\n\n# Wordup for Visual Studio Code\n\nIf you use VSCode for your development, you can install our [VSCode extension](https://marketplace.visualstudio.com/items?itemName=wordup.wordup-code). This extension will integrate all wordup features in your favorite editor.\n\n# License / Contributing\n\nwordup-cli is an open-source project. If you are interested in contributing to wordup-cli, \nfeel free to join us.\n\nSee the [LICENSE](LICENSE) file for details.\n","funding_links":[],"categories":["JavaScript"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwordup-dev%2Fwordup-cli","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fwordup-dev%2Fwordup-cli","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwordup-dev%2Fwordup-cli/lists"}