• pup build
• pup check
  • pup check:tbd
  • pup check:version-conflict
• pup clean
• pup do
• pup get-version
• pup help
• pup i18n
• pup info
• pup package
• pup workflow
• pup zip
• pup zip-name

Runs the build commands from the .puprc file.

If you want your dev builds to build differently, you can add a build_dev property to your .puprc file.

Note: If you need to pass environment variables to your build steps, you can add the env var names to the env property in your .puprc file.

pup build [--dev]
# or
composer -- pup build [--dev]

You can specify build commands within your .puprc file by adding to either the build or build_dev properties. These commands will be run in the order they are specified. By default, if any command fails, the build will fail. You can, however, prepend your commands with @ and that will tell pup to ignore failures for that step. Here's an example:

{
    "build": [
        "npm ci",
        "npm run build",
        "@composer run some-script"
    ]
}

In the above example, npm ci and npm run build will need to complete successfully for the build to succeed, but the composer run some-script is prepended by @ so if it fails, the build will continue forward.

Runs all registered check commands.

You can run all checks specified by your .puprc file (or the .puprc-defaults file if your .puprc file hasn't declared any checks) by running the following command:

pup check
# or
composer -- pup check

Scans your files for tbd (case-insensitive) and tells you where to find them.

The tbd check will scan your files in relevant locations (@since, @todo, @version, etc) and display the files and line numbers where they appear.

pup check:tbd
# or
composer -- pup check:tbd

Verifies that all of your version numbers match.

The version-conflict check looks at all of the version files you've declared in your .puprc file and ensures that they all match. If they do not, it will display the version numbers, file, and associated regex.

Note: If you track your version numbers within package.json, that file only allows versions with two dots (.). For the purposes of validation, pup will consider major.minor.patch versions within package.json to match with major.minor.patch.whatever versions in other files.

pup check:version-conflict
# or
composer -- pup check:version-conflict

This command cleans up any directories that pup creates.

pup clean
# or
composer -- pup clean

Alias for pup workflow. See pup help workflow for more information.

pup do <workflow>
# or
composer -- pup do <workflow>

Gets your project's version number.

This command will use the first version file declared in your .puprc file to get the version number. If you haven't provided a version file, the version will be unknown.

pup get-version [--dev]
# or
composer -- pup get-version [--dev]

Shows the help menu.

pup help [command]
# or
composer -- pup help [command]

Pulls in translations from a GlotPress instance.

pup i18n
# or
composer -- pup i18n

To enable fetching language files from a GlotPress instance, you must specify i18n options in your .puprc file. At a bare minimum, you must specify the following:

"i18n": {
    "slug": "the-slug-used-in-glotpress",
    "textdomain": "my-textdomain",
    "url": "https://translate.wordpress.org/api/projects/wp-plugins/{slug}/stable"
}

By default, the config settings for i18n inherit defaults from the i18n_defaults values in the .puprc-defaults found within pup.

For more information on the available options, see the i18n documentation.

Gets pup details for the current project.

pup info
# or
composer -- pup info

Packages your project into a zip file with the passed in version number.

This command uses the provided version number and builds a zip file with the appropriate name. You can adjust what files get included and excluded from zipping in a couple of ways by adding files to your project:

• .distfiles - If present, the file patterns included here dictate which files/directories matching that pattern to be included. Note: Exclusions in .distignore and .gitattributes supercede these patterns.
• .distignore - Any file pattern included here will cause files/directories matching that pattern to be excluded.
• .gitattributes - Any file pattern with export-ignore after it will be treated similar to files within .distignore.

Patterns in these files support wildcard matching. Use * to match any number of characters and use /**/ to match any number of directories. Examples:

# Match any file ending in .md
*.md

# Match an explicit file in the root of the project
/license.txt

# Match any .min.js file in any directory.
/**/*.min.js

# Match an CSS file in the styles directory.
src/styles/*.css

By default, pup will use its own .distignore-defaults file to exclude a number of common patterns. You can turn the default exclusion rules off by adding "zip_use_default_ignore": false to your .puprc file.

The zip that is generated will be placed in your project's root directory.

pup package <version>
# or
composer -- pup package <version>

Run a command workflow.

Note: If you need to pass environment variables to your workflow steps, you can add the env var names to the env property in your .puprc file.

An example workflow might look like this:

{
    "workflows": {
        "my-workflow": [
            "npm ci",
            "npm run build",
            "@composer run some-script"
        ]
    }
}

Executing this workflow would work like this:

pup workflow my-workflow
# OR
pup do my-workflow
# OR
composer -- pup workflow my-workflow
# OR
composer -- pup do my-workflow

pup workflow <workflow>
# or
pup do <workflow>
# or
composer -- pup workflow <workflow>
# or
composer -- pup do <workflow>

Runs the full pup set of commands to create a zip file.

This command is a wrapper command for the whole zipping process. You can see its flow of commands for more information on which commands it runs and when.

pup zip <branch> [--dev] [--no-clone]
# or
composer -- pup zip <branch> [--dev] [--no-clone]

Gets your project's zip name (sans the .zip extension).

This command will build a zip name based on data provided by .puprc and optionally from arguments passed to the command.

pup zip-name <version> [--dev]
# or
composer -- pup zip-name <version> [--dev]