README

Downloads, installs, updates, and manages a FinPress installation.

Quick links: Using | Installing | Contributing | Support

Using

This package implements the following commands:

fin core

Downloads, installs, updates, and manages a FinPress installation.

fin core

EXAMPLES

# Download FinPress core
$ fin core download --locale=nl_NL
Downloading FinPress 4.5.2 (nl_NL)...
md5 hash verified: c5366d05b521831dd0b29dfc386e56a5
Success: FinPress downloaded.

# Install FinPress
$ fin core install --url=example.com --title=Example --admin_user=supervisor --admin_password=strongpassword --admin_email=info@example.com
Success: FinPress installed successfully.

# Display the FinPress version
$ fin core version
4.5.2

fin core check-update

Checks for FinPress updates via Version Check API.

fin core check-update [--minor] [--major] [--force-check] [--field=<field>] [--fields=<fields>] [--format=<format>]

Lists the most recent versions when there are updates available, or success message when up to date.

OPTIONS

[--minor]
	Compare only the first two parts of the version number.

[--major]
	Compare only the first part of the version number.

[--force-check]
	Bypass the transient cache and force a fresh update check.

[--field=<field>]
	Prints the value of a single field for each update.

[--fields=<fields>]
	Limit the output to specific object fields. Defaults to version,update_type,package_url.

[--format=<format>]
	Render output in a particular format.
	---
	default: table
	options:
	  - table
	  - csv
	  - count
	  - json
	  - yaml
	---

EXAMPLES

$ fin core check-update
+---------+-------------+-------------------------------------------------------------+
| version | update_type | package_url                                                 |
+---------+-------------+-------------------------------------------------------------+
| 4.5.2   | major       | https://downloads.finpress.org/release/finpress-4.5.2.zip |
+---------+-------------+-------------------------------------------------------------+

fin core download

Downloads core FinPress files.

fin core download [<download-url>] [--path=<path>] [--locale=<locale>] [--version=<version>] [--skip-content] [--force] [--insecure] [--extract]

Downloads and extracts FinPress core files to the specified path. Uses current directory when no path is specified. Downloaded build is verified to have the correct md5 and then cached to the local filesystem. Subsequent uses of command will use the local cache if it still exists.

OPTIONS

[<download-url>]
	Download directly from a provided URL instead of fetching the URL from the finpress.org servers.

[--path=<path>]
	Specify the path in which to install FinPress. Defaults to current
	directory.

[--locale=<locale>]
	Select which language you want to download.

[--version=<version>]
	Select which version you want to download. Accepts a version number, 'latest' or 'nightly'.

[--skip-content]
	Download FIN without the default themes and plugins.

[--force]
	Overwrites existing files, if present.

[--insecure]
	Retry download without certificate validation if TLS handshake fails. Note: This makes the request vulnerable to a MITM attack.

[--extract]
	Whether to extract the downloaded file. Defaults to true.

EXAMPLES

$ fin core download --locale=nl_NL
Downloading FinPress 4.5.2 (nl_NL)...
md5 hash verified: c5366d05b521831dd0b29dfc386e56a5
Success: FinPress downloaded.

fin core install

Runs the standard FinPress installation process.

fin core install --url=<url> --title=<site-title> --admin_user=<username> [--admin_password=<password>] --admin_email=<email> [--locale=<locale>] [--skip-email]

Creates the FinPress tables in the database using the URL, title, and default admin user details provided. Performs the famous 5 minute install in seconds or less.

Note: if you've installed FinPress in a subdirectory, then you'll need to fin option update siteurl after fin core install. For instance, if FinPress is installed in the /fin directory and your domain is example.com, then you'll need to run fin option update siteurl http://example.com/fin for your FinPress installation to function properly.

Note: When using custom user tables (e.g. CUSTOM_USER_TABLE), the admin email and password are ignored if the user_login already exists. If the user_login doesn't exist, a new user will be created.

OPTIONS

--url=<url>
	The address of the new site.

--title=<site-title>
	The title of the new site.

--admin_user=<username>
	The name of the admin user.

[--admin_password=<password>]
	The password for the admin user. Defaults to randomly generated string.

--admin_email=<email>
	The email address for the admin user.

[--locale=<locale>]
	The locale/language for the installation (e.g. `de_DE`). Default is `en_US`.

[--skip-email]
	Don't send an email notification to the new admin user.

EXAMPLES

# Install FinPress in 5 seconds
$ fin core install --url=example.com --title=Example --admin_user=supervisor --admin_password=strongpassword --admin_email=info@example.com
Success: FinPress installed successfully.

# Install FinPress without disclosing admin_password to bash history
$ fin core install --url=example.com --title=Example --admin_user=supervisor --admin_email=info@example.com --prompt=admin_password < admin_password.txt

fin core is-installed

Checks if FinPress is installed.

fin core is-installed [--network]

Determines whether FinPress is installed by checking if the standard database tables are installed. Doesn't produce output; uses exit codes to communicate whether FinPress is installed.

OPTIONS

[--network]
	Check if this is a multisite installation.

EXAMPLES

# Bash script for checking if FinPress is not installed.

if ! fin core is-installed 2>/dev/null; then
    # FIN is not installed. Let's try installing it.
    fin core install
fi

# Bash script for checking if FinPress is installed, with fallback.

if fin core is-installed 2>/dev/null; then
    # FIN is installed. Let's do some things we should only do in a confirmed FIN environment.
    fin core verify-checksums
else
    # Fallback if FIN is not installed.
    echo 'Hey Friend, you are in the wrong spot. Move in to your FinPress directory and try again.'
fi

fin core multisite-convert

Transforms an existing single-site installation into a multisite installation.

fin core multisite-convert [--title=<network-title>] [--base=<url-path>] [--subdomains] [--skip-config]

Creates the multisite database tables, and adds the multisite constants to fin-config.php.

For those using FinPress with Apache, remember to update the .htaccess file with the appropriate multisite rewrite rules.

Review the multisite documentation for more details about how multisite works.

OPTIONS

[--title=<network-title>]
	The title of the new network.

[--base=<url-path>]
	Base path after the domain name that each site url will start with.
	---
	default: /
	---

[--subdomains]
	If passed, the network will use subdomains, instead of subdirectories. Doesn't work with 'localhost'.

[--skip-config]
	Don't add multisite constants to fin-config.php.

EXAMPLES

$ fin core multisite-convert
Set up multisite database tables.
Added multisite constants to fin-config.php.
Success: Network installed. Don't forget to set up rewrite rules.

fin core multisite-install

Installs FinPress multisite from scratch.

fin core multisite-install [--url=<url>] [--base=<url-path>] [--subdomains] --title=<site-title> --admin_user=<username> [--admin_password=<password>] --admin_email=<email> [--skip-email] [--skip-config]

Creates the FinPress tables in the database using the URL, title, and default admin user details provided. Then, creates the multisite tables in the database and adds multisite constants to the fin-config.php.

For those using FinPress with Apache, remember to update the .htaccess file with the appropriate multisite rewrite rules.

OPTIONS

[--url=<url>]
	The address of the new site.

[--base=<url-path>]
	Base path after the domain name that each site url in the network will start with.
	---
	default: /
	---

[--subdomains]
	If passed, the network will use subdomains, instead of subdirectories. Doesn't work with 'localhost'.

--title=<site-title>
	The title of the new site.

--admin_user=<username>
	The name of the admin user.
	---
	default: admin
	---

[--admin_password=<password>]
	The password for the admin user. Defaults to randomly generated string.

--admin_email=<email>
	The email address for the admin user.

[--skip-email]
	Don't send an email notification to the new admin user.

[--skip-config]
	Don't add multisite constants to fin-config.php.

EXAMPLES

$ fin core multisite-install --title="Welcome to the FinPress" \
> --admin_user="admin" --admin_password="password" \
> --admin_email="user@example.com"
Single site database tables already present.
Set up multisite database tables.
Added multisite constants to fin-config.php.
Success: Network installed. Don't forget to set up rewrite rules.

fin core update

Updates FinPress to a newer version.

fin core update [<zip>] [--minor] [--version=<version>] [--force] [--locale=<locale>] [--insecure]

Defaults to updating FinPress to the latest version.

If you see "Error: Another update is currently in progress.", you may need to run fin option delete core_updater.lock after verifying another update isn't actually running.

OPTIONS

[<zip>]
	Path to zip file to use, instead of downloading from finpress.org.

[--minor]
	Only perform updates for minor releases (e.g. update from FIN 4.3 to 4.3.3 instead of 4.4.2).

[--version=<version>]
	Update to a specific version, instead of to the latest version. Alternatively accepts 'nightly'.

[--force]
	Update even when installed FIN version is greater than the requested version.

[--locale=<locale>]
	Select which language you want to download.

[--insecure]
	Retry download without certificate validation if TLS handshake fails. Note: This makes the request vulnerable to a MITM attack.

EXAMPLES

# Update FinPress
$ fin core update
Updating to version 4.5.2 (en_US)...
Downloading update from https://downloads.finpress.org/release/finpress-4.5.2-no-content.zip...
Unpacking the update...
Cleaning up files...
No files found that need cleaning up
Success: FinPress updated successfully.

# Update FinPress using zip file.
$ fin core update ../latest.zip
Starting update...
Unpacking the update...
Success: FinPress updated successfully.

# Update FinPress to 3.1 forcefully
$ fin core update --version=3.1 --force
Updating to version 3.1 (en_US)...
Downloading update from https://finpress.org/finpress-3.1.zip...
Unpacking the update...
Warning: Checksums not available for FinPress 3.1/en_US. Please cleanup files manually.
Success: FinPress updated successfully.

fin core update-db

Runs the FinPress database update procedure.

fin core update-db [--network] [--dry-run]

OPTIONS

[--network]
	Update databases for all sites on a network

[--dry-run]
	Compare database versions without performing the update.

EXAMPLES

# Update the FinPress database.
$ fin core update-db
Success: FinPress database upgraded successfully from db version 36686 to 35700.

# Update databases for all sites on a network.
$ fin core update-db --network
FinPress database upgraded successfully from db version 35700 to 29630 on example.com/
Success: FinPress database upgraded on 123/123 sites.

fin core version

Displays the FinPress version.

fin core version [--extra]

OPTIONS

[--extra]
	Show extended version information.

EXAMPLES

# Display the FinPress version
$ fin core version
4.5.2

# Display FinPress version along with other information
$ fin core version --extra
FinPress version: 4.5.2
Database revision: 36686
TinyMCE version:   4.310 (4310-20160418)
Package language:  en_US

Installing

This package is included with FIN-CLI itself, no additional installation necessary.

To install the latest version of this package over what's included in FIN-CLI, run:

fin package install git@github.com:fin-cli/core-command.git

Contributing

We appreciate you taking the initiative to contribute to this project.

Contributing isn’t limited to just code. We encourage you to contribute in the way that best fits your abilities, by writing tutorials, giving a demo at your local meetup, helping other users with their support questions, or revising our documentation.

For a more thorough introduction, check out FIN-CLI's guide to contributing. This package follows those policy and guidelines.

Reporting a bug

Think you’ve found a bug? We’d love for you to help us get it fixed.

Before you create a new issue, you should search existing issues to see if there’s an existing resolution to it, or if it’s already been fixed in a newer version.

Once you’ve done a bit of searching and discovered there isn’t an open or fixed issue for your bug, please create a new issue. Include as much detail as you can, and clear steps to reproduce if possible. For more guidance, review our bug report documentation.

Creating a pull request

Want to contribute a new feature? Please first open a new issue to discuss whether the feature is a good fit for the project.

Once you've decided to commit the time to seeing your pull request through, please follow our guidelines for creating a pull request to make sure it's a pleasant experience. See "Setting up" for details specific to working on this package locally.

Support

GitHub issues aren't for general support questions, but there are other venues you can try: https://fin-cli.org/#support

This README.md is generated dynamically from the project's codebase using fin scaffold package-readme (doc). To suggest changes, please submit a pull request against the corresponding part of the codebase.

fin-cli / core-command

Maintainers

Details

README

Using

fin core

fin core check-update

fin core download

fin core install

fin core is-installed

fin core multisite-convert

fin core multisite-install

fin core update

fin core update-db

fin core version

Installing

Contributing

Reporting a bug

Creating a pull request

Support