Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/source/content/terminus/01-introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Terminus is a command line interface that provides advanced interaction with Pan

## Terminus Features

Terminus is a powerful tool that allows you to:
Terminus allows you to:

- Create a new site
- Create and delete Multidev environments
Expand Down
4 changes: 2 additions & 2 deletions src/source/content/terminus/03-examples.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ The example above is equivalent to `terminus env:info mysite.dev`.

Pantheon supports [Drush (Drupal)](https://drushcommands.com/) and [WP-CLI (WordPress)](https://developer.wordpress.org/cli/commands/) commands remotely against a target site environment through Terminus. This is often faster and easier than leveraging such tools via local installations.

1. Use the [basic command structure described above](#command-structure).
1. Use the [basic command structure described above](#basic-format).

The commands to invoke Drush and WP-CLI are:
- `remote:drush`
Expand Down Expand Up @@ -431,7 +431,7 @@ Every site has an assigned upstream to deliver [one-click updates](/core-updates

</Alert>

1. Apply updates to the site to bring in the new codebase after setting the upstream. Refer to the [example usage above](#applying-updates) for information on how to apply updates.
1. Apply updates to the site to bring in the new codebase after setting the upstream. Refer to the [example usage above](#apply-updates) for information on how to apply updates.

## Troubleshoot Upstreams

Expand Down
4 changes: 2 additions & 2 deletions src/source/content/terminus/05-scripting.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ If so, consider how you can turn the task into a script.

## Authentication

Terminus must be authenticated before you can execute most commands. You must authenticate Terminus with a [machine token](/terminus/install#machine-token) that has the correct permissions before running a script.
Terminus must be authenticated before you can execute most commands. You must authenticate Terminus with a [machine token](/terminus/install#login-via-machine-token-required) that has the correct permissions before running a script.

### Authenticate Terminus for Continuous Integration

Expand Down Expand Up @@ -70,7 +70,7 @@ Terminus can generate variables for scripting. In the example below, `terminus m
PANTHEON_MULTIDEV_LIST="$(terminus multidev:list -n ${TERMINUS_SITE} --format=list --field=Name)"
```

This example assumes the variable `TERMINUS_SITE` is already set. You can iterate through `$PANTHEON_MULTIDEV_LIST` using a `while read` loop to perform tasks on each Multidev environment.
This example assumes the variable `TERMINUS_SITE` is already set. Unlike the `ORG_UUID` and `PANTHEON_ORG` variables in the examples below, `TERMINUS_SITE` is a Terminus-recognized environment variable, so you can export it once (in your shell profile or CI environment) instead of setting it within each script. You can iterate through `$PANTHEON_MULTIDEV_LIST` using a `while read` loop to perform tasks on each Multidev environment.

## Interactive Prompts

Expand Down
2 changes: 2 additions & 0 deletions src/source/content/terminus/06-plugins.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,5 +47,7 @@ terminus self:plugin:uninstall pantheon-systems/terminus-plugin-example

## More Resources

- [Plugin Directory](/terminus/directory)
- [Create Terminus Plugins](/terminus/create)
- [WordPress Plugins and Themes with Known Issues](/wordpress-known-issues)
- [Drupal Modules with Known Issues](/modules-known-issues)
20 changes: 10 additions & 10 deletions src/source/content/terminus/07-create.md
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ Some of the following instructions may break your plugin temporarily. We recomme

```json
{
"name": "pantheon-systems\terminus-hello-world"
"name": "pantheon-systems/terminus-hello-world"
}
```

Expand All @@ -113,11 +113,11 @@ Some of the following instructions may break your plugin temporarily. We recomme
"description": "An Hello, World Terminus command",
"type": "terminus-plugin",
"autoload": {
"psr-4": { "Pantheon\\TerminusHello\\": "src" }
"psr-4": { "Pantheon\\TerminusHelloWorld\\": "src" }
},
"extra": {
"terminus": {
"compatible-version": "^3"
"compatible-version": "^4"
}
}
}
Expand Down Expand Up @@ -161,16 +161,16 @@ The instructions in this section demonstrate how to set up simple functional tes
"description": "A Hello, World Terminus command",
"type": "terminus-plugin",
"autoload": {
"psr-4": { "Pantheon\\TerminusHello\\": "src" }
"psr-4": { "Pantheon\\TerminusHelloWorld\\": "src" }
},
"require": {
"organization/project-name": "^1"
},
"extra": {
"terminus": {
"compatible-version": "^1.1"
"compatible-version": "^4"
}
}
},
"require-dev": {
"squizlabs/php_codesniffer": "^2.7"
},
Expand Down Expand Up @@ -208,7 +208,7 @@ The instructions in this section demonstrate how to set up simple functional tes

1. Add the following lines to the `.gitignore`file. This is **strongly** recommended because of the additional files created by these tests.

```bash{promptUser: user}
```text
vendor
bats
bin
Expand All @@ -218,7 +218,7 @@ The instructions in this section demonstrate how to set up simple functional tes

1. Define your Bats tests. Create a folder named `tests`, and create a file named `confirm-install.bats`. Place the content below in your Bats test file:

``````bash{promptUser: user}
```bash{promptUser: user}
#!/usr/bin/env bats

#
Expand Down Expand Up @@ -262,7 +262,7 @@ You can [configure your project tests to run automatically on Circle CI](https:/
timezone:
America/Chicago
php:
version: 7.0.11
version: 8.1
environment:
PATH: $PATH:~/.composer/vendor/bin:~/.config/composer/vendor/bin:$HOME/bin

Expand All @@ -273,7 +273,7 @@ You can [configure your project tests to run automatically on Circle CI](https:/
- composer install --prefer-dist -n
- composer install-bats
- composer global require -n "consolidation/cgr"
- cgr "pantheon-systems/terminus:^1.1"
- cgr "pantheon-systems/terminus:^4"
post:
- terminus auth:login --machine-token=$TERMINUS_TOKEN
test:
Expand Down
4 changes: 2 additions & 2 deletions src/source/content/terminus/09-configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,15 +47,15 @@ command:

The example above does three things:

- Terminus warns you when running commands in an environment set to Git mode, unaware if the command affects the codebase or not.
- By default, Terminus warns you when running commands in an environment set to Git mode, unaware if the command affects the codebase or not. Set `hide_git_mode_warning: 1` to disable that warning.

- The `terminus auth:login` command automatically provides the correct email address when it runs. This is useful if you find yourself logging in to multiple accounts frequently, and want to use your regular account by default.

```none
[warning] This environment is in read-only Git mode. If you want to make changes to the codebase of this site (e.g. updating modules or plugins), you will need to toggle into read/write SFTP mode first.
```

Defining `TERMINUS_HIDE_GIT_MODE_WARNING` disables that message, which is useful for those using Terminus for frequent changes to files, not code. <Popover content="Refer to <a href='/pantheon-workflow'>Use the Pantheon WebOps Workflow</a> for more information on Code versus Content."/>
Set the environment variable `TERMINUS_HIDE_GIT_MODE_WARNING` for the same effect as `hide_git_mode_warning: 1` in `config.yml` — Terminus maps any `TERMINUS_<KEY>` environment variable to the matching `config.yml` key automatically, so the two are interchangeable. This is useful for those using Terminus for frequent changes to files, not code. <Popover content="Refer to <a href='/pantheon-workflow'>Use the Pantheon WebOps Workflow</a> for more information on Code versus Content."/>

- The Terminus Plugin [Pancakes](https://github.com/terminus-plugin-project/terminus-pancakes-plugin) lets you open your Pantheon site database with a SQL GUI client. Rather than define the app every time. This configuration always uses [Sequel Ace](https://sequel-ace.com/) unless otherwise specified.

Expand Down
2 changes: 2 additions & 0 deletions src/source/content/terminus/10-supported-terminus.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,8 @@ Each major and minor version of Terminus is fully supported for one year from th

After this period, the version will reach End Of Life (**EOL**), and will no longer be supported. We recommend you update Terminus far in advance of the EOL schedule, so that regressions in new versions can be reported and patched in time.

## Version Support

| Version | Release Date | EOL Date |
|------------------|--------------------|--------------------|
| 4.3.2 | June 23, 2026 | |
Expand Down
3 changes: 2 additions & 1 deletion src/source/content/terminus/11-updates.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,4 +23,5 @@ integration: [--]
## More Resources

- [Terminus Command Reference](/terminus/commands)
- [Terminus 4.0](/terminus/updates)
- [Terminus 4.0 Migration Guide](/terminus/terminus-4-0)
- [Terminus 3.0 Migration Guide](/terminus/terminus-3-0)
2 changes: 1 addition & 1 deletion src/source/content/terminus/12-terminus-3-0.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ product: [terminus]
integration: [--]
---

This section provides information about Terminus 3.0. Terminus 3.0 is the most recent major version of Terminus and is recommended in place of Terminus 2.0.
This section provides information about Terminus 3.0, which was recommended in place of Terminus 2.0. Terminus 3.0 is no longer the most recent major version — see the [Terminus 4.0 Migration Guide](/terminus/terminus-4-0) if you're upgrading from Terminus 2.x or earlier.

<Alert title="Note" type="info" >

Expand Down
2 changes: 1 addition & 1 deletion src/source/content/terminus/ci/bitbucket.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ integration: [--]
reviewed: "2023-06-08"
---

This section provides information on how to to authenticate Terminus in a Bitbucket CI pipeline without receiving errors and avoiding authentication rate limits.
This section provides information on how to authenticate Terminus in a Bitbucket CI pipeline without receiving errors and avoiding authentication rate limits.

## Caching Authentication for Bitbucket Pipelines

Expand Down
3 changes: 1 addition & 2 deletions src/source/content/terminus/ci/circleci.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,8 +41,7 @@ You can use the example script in this section for a full start-to-finish Termin

Before you use this script:

- Replace `TOKEN` in the script below with the machine token provided by Terminus.
- Add the machine token provided by Terminus to your environment variables in the CircleCI project settings.
- Add a `TERMINUS_TOKEN` environment variable in your CircleCI project settings, set to the machine token provided by Terminus.

</Alert>

Expand Down
2 changes: 1 addition & 1 deletion src/source/content/terminus/ci/github-actions.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ integration: [--]
reviewed: "2025-12-10"
---

This section provides information on how to to authenticate Terminus in a GitHub Actions CI pipeline without receiving errors and avoiding authentication rate limits.
This section provides information on how to authenticate Terminus in a GitHub Actions CI pipeline without receiving errors and avoiding authentication rate limits.

## Caching Authentication for GitHub Actions

Expand Down
2 changes: 1 addition & 1 deletion src/source/content/terminus/ci/gitlab.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ integration: [--]
reviewed: "2023-06-08"
---

This section provides information on how to to authenticate Terminus in a GitLab CI pipeline without receiving errors and avoiding authentication rate limits.
This section provides information on how to authenticate Terminus in a GitLab CI pipeline without receiving errors and avoiding authentication rate limits.

## Caching Authentication for GitLab

Expand Down
Loading