README

WPEnv Console is a command-line tool designed to simplify WordPress development and management tasks. It that extends the functionality of the WPEnv development environment. It provides a set of commands to streamline common WordPress tasks and enhance your workflow. Whether you're setting up a new WordPress environment, managing plugins and themes, or performing routine maintenance, WPEnv Console has you covered.

Note This repository houses the fundamental console components of wp-env-config. If you are developing an application, please utilize wp-env-app located in this repository: wp-env-app.

Features

WordPress Environment Management: Easily create, configure, and manage WordPress environments with commands like make:env, serve, and setup.
Plugin and Theme Installation: Install and manage plugins and themes directly from the WordPress Packagist repository using the install:package command.
Database Management: Create database backups, generate .htpasswd files for authentication, and set up database admin directories with ease.
WordPress Installation: Quickly install WordPress with customizable options using the wp:install command.
Auto-login URLs: Generate auto-login URLs for users during development and testing with the wp:login command.

Installation

You can install WPEnv Console via Composer by running:

composer require devuri/wpenv-console

Usage

Once installed, you can run WPEnv Console commands using php bin/nino followed by the desired command. For example:

php nino make:env my-project

For a complete list of available commands and their descriptions, run:

php nino list

Available Commands

WPEnv Console offers the following commands to simplify your WordPress development tasks:

Make Environment: Create a new WordPress environment.
```
php bin/nino make:env <name>
```
Serve: Start the built-in PHP web server.
```
php bin/nino serve
```
Setup: Creates a fresh .env file .
```
php bin/nino setup <replacement_domain>
```
Running php nino setup will check for an existing .env file. If found, it creates a new version with a timestamp, facilitating an effortless update to the latest .env file standards.
Install Package: Add a plugin or theme via Composer using the slug only.
```
php bin/nino install <package_slug>  <plugin_or_theme>
```

Generate .htpasswd: Create an .htpasswd file for authentication.

php bin/nino make:htpass [--username=<username>] [--password=<password>]

Database Backup: Backup the WordPress database.
```
php bin/nino db:backup
```
Generate Composer: Generate a fresh copy of composer.json and run composer install.
```
php bin/nino make:composer
```

WordPress Installation: Install WordPress with customizable options.

php bin/nino wp:install [--title=<blog_title>] [--user=<admin_username>] [--email=<admin_email>]

WordPress Auto-login: Generate an auto-login URL for a user.
```
php bin/nino wp:login [--user=<admin_username>]
```
Create DB Admin Directory: Create a database admin directory.
```
php bin/nino make:dbadmin [--_dir=<directory_name>]
```

Contributing

Contributions, issues, and feature requests are welcome! Feel free to check out the contributing guidelines and code of conduct.

License

WPEnv Console is open-source software licensed under the MIT License. You are free to use, modify, and distribute it as per the terms of the license.

Support and Feedback

For questions, issues, or feedback related to WPEnv Console, please visit the GitHub repository or join the community.

devuri / wpenv-console

Maintainers

Details