CLI
Usa questa pagina per consultare comandi, opzioni, codici di uscita e variabili di afe.
Il comando afe esegue i flow, serve il motore e ispeziona i ticket. Parla con un server
attraverso l'API, a meno che un comando non dica --local.
afe --help
afe <command> --help
afe validate
Controlla ogni manifest in una cartella e stampa tutti i problemi.
afe validate config/ # la cartella come posizionale
afe validate -c config/ # oppure con il flag
| Opzione | Predefinito | Significato |
|---|---|---|
[folder] | — | La cartella di configurazione, come posizionale (equivale a --config). |
--config, -c | . | La cartella di configurazione. |
Codice di uscita 1 quando c'è un errore, 0 altrimenti.
afe serve
Serve l'API del motore su una cartella di configurazione. Il token viene da AFE_API_TOKEN.
| Opzione | Predefinito | Significato |
|---|---|---|
--config, -c | . | La cartella di configurazione. |
--host | 127.0.0.1 | L'interfaccia su cui ascoltare. |
--port | 8765 | La porta su cui ascoltare. |
--ops-host | 127.0.0.1 | L'interfaccia per /livez, /readyz e /metrics. |
--ops-port | off | La porta per /livez, /readyz e /metrics; spenta quando assente. |
--session-hours | 8 | Ore di durata di una sessione del browser. |
--ui | off | Serve anche la UI web. |
afe worker
Esegue i ticket in coda fino a SIGINT o SIGTERM.
| Opzione | Predefinito | Significato |
|---|---|---|
--config, -c | . | La cartella di configurazione. |
--concurrency | 1 | Ticket da eseguire insieme. |
--dry | off | Esegue gli agenti sull'harness dry. |
--ops-host | 127.0.0.1 | L'interfaccia per /livez, /readyz e /metrics. |
--ops-port | off | La porta per /livez, /readyz e /metrics; spenta quando assente. |
afe run
Avvia un ticket e lo segue; risponde alle sue domande quando c'è un terminale.
| Opzione | Predefinito | Significato |
|---|---|---|
<flow> | — | Il flow da eseguire (posizionale). |
--input, -i | — | L'input del ticket (YAML). Obbligatorio. |
--config, -c | . | La cartella di configurazione, con --local. |
--url | ws://127.0.0.1:8765/rpc | L'URL dell'API del motore. |
--local | off | Esegue il motore nel processo. |
--dry | off | Con --local: agenti sull'harness dry. |
--project | — | Il progetto su cui lavora il flow. |
--revision | current | Esegue su questa revisione di configurazione, non quella corrente. |
afe resume
Risponde a un ticket in pausa (o lo riavvia) e lo segue.
| Opzione | Predefinito | Significato |
|---|---|---|
<ticket> | — | Il ticket da riprendere (posizionale). |
[action] | — | La risposta, una delle azioni offerte (posizionale). |
--comment | — | Un commento con la risposta. |
--url | ws://127.0.0.1:8765/rpc | L'URL dell'API del motore. |
afe rerun
Avvia di nuovo un ticket sulla stessa revisione di configurazione, e lo segue.
| Opzione | Predefinito | Significato |
|---|---|---|
<ticket> | — | Il ticket da eseguire di nuovo (posizionale). |
--url | ws://127.0.0.1:8765/rpc | L'URL dell'API del motore. |
afe cancel
Annulla un ticket; i suoi artefatti restano.
| Opzione | Predefinito | Significato |
|---|---|---|
<ticket> | — | Il ticket da annullare (posizionale). |
--url | ws://127.0.0.1:8765/rpc | L'URL dell'API del motore. |
afe inspect
Mostra un ticket: stato, consumi totali, la domanda su cui aspetta, artefatti.
| Opzione | Predefinito | Significato |
|---|---|---|
<ticket> | — | Il ticket da mostrare (posizionale). |
--url | ws://127.0.0.1:8765/rpc | L'URL dell'API del motore. |
afe tickets
Elenca i ticket.
| Opzione | Predefinito | Significato |
|---|---|---|
--state | all | Solo i ticket in questo stato. |
--url | ws://127.0.0.1:8765/rpc | L'URL dell'API del motore. |
afe workers
Elenca i worker vivi e le metriche della coda.
| Opzione | Predefinito | Significato |
|---|---|---|
--url | ws://127.0.0.1:8765/rpc | L'URL dell'API del motore. |
Codici di uscita
| Codice | Significato |
|---|---|
0 | Il ticket è concluso. |
2 | Il ticket aspetta una persona. |
1 | Qualunque altro caso: un guasto, una configurazione sbagliata, un errore dell'API. |
Ambiente
| Variabile | Letta da | Significato |
|---|---|---|
AFE_API_TOKEN | i comandi remoti | Il bearer token; obbligatorio per parlare con un server. |
AFE_POSTGRES_DSN, AFE_REDIS_URL | serve, worker | Le stringhe di connessione nominate da un Runtime (vedi Runtime). |
Un comando remoto senza AFE_API_TOKEN stampa una riga, error: set AFE_API_TOKEN to talk to a server, ed esce con 1 invece di un traceback.