# CLI

Rudel rekisteröi komentonsa kohteen `wp rudel` alle. WP-CLI hylkää kohteen `unknown --<name> parameter` avulla asetuksen, jota komento ei tässä luettelossa hyväksy.

Voit nimetä juurikomennon uudelleen upotettua käyttöä varten määrittämällä arvon `RUDEL_CLI_COMMAND` kohteessa `wp-config.php` ennen lisäosan lataamista.

```php
define( 'RUDEL_CLI_COMMAND', 'sandbox' );
```

Se muuttaa kohteen `wp rudel create` kohteeksi `wp sandbox create`. Komennon toiminta ei muutu.

Komennot suoritetaan oletuksena isännässä. Suorita jokin muu WP-CLI-komento hiekkalaatikossa asettamalla `RUDEL_ENVIRONMENT`:

```bash
RUDEL_ENVIRONMENT=alpha-3be7 wp option get blogname
```

## create

```bash
wp rudel create [--name=<name>] [--theme=<slug>] [--clone-from=<id>] [--owner=<owner>] [--labels=<labels>] [--purpose=<purpose>] [--protected] [--ttl-days=<days>] [--expires-at=<timestamp>] [--git=<remote>] [--type=<theme|plugin>] [--template=<label>]
```

Luo hiekkalaatikon ja tulostaa sen tunnuksen.

| Valitsin | Merkitys |
|--------|---------|
| `--name` | Ihmisluettava nimi. Tunnus on nimi ja neljä heksadesimaalimerkkiä. Oletuksena repositorion nimi, kun käytössä on `--git`, muuten `sandbox`. |
| `--theme` | Hiekkalaatikkoon kopioitava teema. Sen on oltava asennettuna isäntään. Oletuksena isännän aktiivinen teema tai lähdehiekkalaatikon teema, kun käytössä on `--clone-from`. |
| `--clone-from` | Kloonaa taulut ja teeman olemassa olevasta hiekkalaatikosta isännän sijaan. |
| `--owner`, `--labels`, `--purpose` | Metadata. Tunnisteet erotellaan pilkuilla. |
| `--protected` | Estää hiekkalaatikon poistamisen siivouksessa. |
| `--ttl-days` | Vanhenemisaika luontihetkestä laskettuna. |
| `--expires-at` | Nimenomainen vanhenemisen aikaleima. |
| `--git` | Kloonaa etärepositorion hiekkalaatikkohakemistoon. Katso [Git](https://rudel.inline0.dev/fi/docs/features/git). |
| `--type` | Mihin kohde `--git` kirjataan ulos: `theme` (oletus) tai `plugin`. |
| `--template` | Tietueeseen tallennettava tunniste, oletuksena `blank`. Ei lataa tallennettua mallipohjaa. |

`--clone-db`, `--clone-themes`, `--clone-plugins`, `--clone-uploads`, `--clone-all`, `--shared-plugins` ja `--shared-uploads` ovat vanhentuneita. Ne muuttavat vain edistymisviestejä: jokainen hiekkalaatikko kloonaa taulut, kopioi yhden teeman ja jakaa lisäosat sekä lataukset.

Komento päättyy kehotteeseen siirtyä kohteen `cd` hiekkalaatikkohakemistoon ja suorittaa `wp post list`. Se suoritetaan isännässä, koska hiekkalaatikkohakemiston kohde `wp-cli.yml` osoittaa isännän kohteeseen URL. Käytä sen sijaan kohdetta `RUDEL_ENVIRONMENT`.

## list

```bash
wp rudel list [--format=<table|json|csv|yaml|count>]
```

Luettelee hiekkalaatikot ja näyttää tunnuksen, nimen, omistajan, suojauksen, vanhenemisajan, tilan, mallipohjatunnisteen, luontiajan ja hakemiston koon.

## info

```bash
wp rudel info <id> [--format=<table|json|yaml>]
```

Näyttää yhden hiekkalaatikkotietueen, mukaan lukien taulujen etuliitteen, teeman, tunnisteet, kloonauksen metatiedot, URL-arvon ja sisällön polun.

## update

```bash
wp rudel update <id> [--owner=<owner>] [--labels=<labels>] [--purpose=<purpose>] [--protected] [--unprotected] [--ttl-days=<days>] [--expires-at=<timestamp>] [--clear-expiry]
```

Päivittää metatiedot. `--ttl-days` lasketaan tästä hetkestä. Se ei muuta hiekkalaatikon sivustosisältöä.

## destroy

```bash
wp rudel destroy <id> [--force]
```

Poistaa hiekkalaatikon taulut, hakemiston ja siihen linkitetyt työpuut sekä tietueen. Komento pyytää vahvistusta; `--force` ohittaa kehotteen. Suojaus ei estä kohteen `destroy` toimintaa: suojattu hiekkalaatikko tuhotaan kuten mikä tahansa muu.

## status

```bash
wp rudel status
```

Tulostaa taulukon, jossa näkyvät käynnistystila, nykyinen hiekkalaatikko, hiekkalaatikoiden hakemisto ja määrä, kohteen `rudel_config` arvot sekä tieto siitä, onko automaatio ajastettu. Se tulostaa aina taulukon ja ohittaa kohteen `--format`.

## cleanup

```bash
wp rudel cleanup [--dry-run] [--max-age-days=<days>] [--max-idle-days=<days>] [--merged]
```

Ilman kohdetta `--merged` poistaa suojaamattomat hiekkalaatikot, joiden vanhenemisaika on mennyt tai jotka ylittävät ikärajan tai ovat olleet käyttämättöminä sallittua pidempään. `--max-age-days` ja `--max-idle-days` ohittavat kohteen `rudel_config` tässä suorituksessa. Kohteen `--merged` kanssa poistetaan hiekkalaatikot, joiden linkitettyjen Git-työpuiden haarat on yhdistetty. Suojatut hiekkalaatikot ohitetaan aina. Katso [Siivous](https://rudel.inline0.dev/fi/docs/features/cleanup).

## logs

```bash
wp rudel logs <id> [--lines=<lines>] [--follow] [--clear]
```

Tulostaa hiekkalaatikon `debug.log`-tiedoston viimeiset rivit (oletus 50). `--follow` suorittaa kohteen `tail -f`; `--clear` tyhjentää tiedoston. Katso [Virhelokitus](https://rudel.inline0.dev/fi/docs/features/logging).

## snapshot

```bash
wp rudel snapshot <id> --name=<name>
```

Luo nimetyn tilannevedoksen.

## restore

```bash
wp rudel restore <id> --snapshot=<name> [--force]
```

Palauttaa tilannevedoksen. Komento pyytää vahvistusta; `--force` ohittaa kehotteen. Katso [Tilannevedokset](https://rudel.inline0.dev/fi/docs/features/snapshots).

## template

```bash
wp rudel template save <id> --name=<name> [--description=<description>]
wp rudel template list [--format=<table|json|csv|yaml|count>]
wp rudel template delete <name> [--force]
```

Tallentaa, luettelee ja poistaa mallipohjakopioita. Mikään komento ei luo hiekkalaatikkoa tallennetusta mallipohjasta. Katso [Mallipohjat](https://rudel.inline0.dev/fi/docs/features/templates).

## push

```bash
wp rudel push <id> [--git=<remote>] [--dir=<dir>] [--message=<message>]
```

Vahvistaa hiekkalaatikon hakemiston sisällä olevan työkopion muutokset ja työntää ne haaraan `rudel/<id>`.

| Valitsin | Merkitys |
|--------|---------|
| `--git` | Etä-URL. Tarvitaan vain, jos arvoa ei ole tallennettu; muistetaan ensimmäisen onnistuneen työnnön jälkeen. |
| `--dir` | Hiekkalaatikkohakemistoon suhteutettu hakemisto, esimerkiksi `themes/my-theme`. Oletuksena tallennettu työkopion hakemisto tai koko hiekkalaatikkohakemisto. |
| `--message` | Commit-viesti, oletuksena `Update from Rudel sandbox`. |

Katso [Git](https://rudel.inline0.dev/fi/docs/features/git).