CLI
Inicie sesión, consulte, cargue archivos, ejecute agentes y despliegue desde su terminal.
El comando klarety viene con el de Python. Hace lo mismo que el SDK desde su terminal e imprime JSON para encadenarlo.
Instale e inicie sesión
Disponible bajo solicitud
El SDK y la CLI de Klarety están disponibles bajo solicitud. Para solicitar acceso para su espacio de trabajo, contáctenos.
Instale
pip install klarety
klarety --helpGuarde su clave
Cree una en ConfiguraciónSDK y API y luego:
klarety login "paste-your-key-here"La clave va al llavero del sistema, nunca a un archivo. La CLI imprime key stored in the OS keychain.
Compruebe que funciona
klarety sql "SELECT 1 AS ok"klarety logout olvida la clave guardada. Todos los comandos aceptan --base-url antes del nombre del comando; por defecto es https://api.klarety.ai.
Consulte
klarety sql
klarety sql "SELECT customer, SUM(amount) AS total FROM orders GROUP BY customer" --max-rows 50| Argumento | Significado |
|---|---|
statement | Una sentencia SQL, entre comillas. |
--max-rows | Máximo de filas a imprimir, 1.000 por defecto. |
klarety tables
klarety tablesLista las tablas de su esquema default.
Cargue datos
klarety ingest
klarety ingest sales.csv --into sales --mode upsert --key order_idCarga un archivo local en una tabla e imprime el run_id y el state.
klarety put
klarety put q3-summary.pdf reports/q3 --name summary.pdfGuarda un archivo en una carpeta, por la ruta de la carpeta como la muestra el Almacenamiento de objetos. --name define su nombre allí.
klarety load
klarety load exports/daily --into daily_exports --mode appendCarga en una tabla todos los archivos que están directamente en la carpeta.
Opciones de carga
ingest y load comparten estas opciones. Vea Cargar datos para lo que hace cada modo.
| Opción | Significado |
|---|---|
--into | La tabla en la que se carga. |
--schema | El esquema (solo ingest), default por defecto. |
--mode | auto (por defecto), append, upsert o replace. |
--key | Una columna que identifica una fila. Repítala para varias columnas. |
--force | Carga de nuevo un archivo que ya se cargó. |
Agentes
klarety agent trabaja con los de un . Pase --project <id> antes de la acción.
klarety agent --project <project-id> test daily-summary --input days=1| Acción | Qué hace |
|---|---|
check <name> | Revisa agents/<name>.yaml sin guardarlo. |
save <name> | Guarda el YAML y su código como borrador. |
test <name> | Guarda y luego ejecuta el borrador. Acepta --input name=value, repetible. |
publish <name> | Guarda y luego pide a una persona que lo publique. Pasa a vivo cuando esa persona lo hace. |
run <name> | Ejecuta ya la versión en vivo. Acepta --input. |
runs <name> | Lista las 20 ejecuciones más recientes del agente. |
show <run_id> | Una ejecución, paso a paso. |
result <run_id> | Lo que produjo una ejecución. |
stop <run_id> | Detiene una ejecución. |
stats | Ejecuciones por día: cuántas, cómo terminaron, el costo. --days, 7 por defecto. |
rerun <run_id> --from-step <step> | Ejecuta de nuevo desde un paso, reutilizando el resto. |
En --input, 7 se lee como número y true como booleano; todo lo demás es texto.
Despliegue
klarety deploy --project <project-id> la rama de GitHub vinculada al proyecto. Sin repositorio vinculado, envía el commit que está en --repo (la carpeta actual por defecto). Imprime el deploy_id.
Códigos de salida
| Código | Significado |
|---|---|
0 | Listo. |
2 | Rechazado o fallido. El motivo se imprime en stderr. |
3 | Esperando que una persona apruebe. No falló, pero tampoco terminó. |
La salida va a stdout y los mensajes a stderr, así que klarety sql "..." | jq queda limpio.
Próximos pasos
- Autenticación para claves y rotación.
- Agentes y ejecuciones para las mismas acciones en Python.
- Errores para lo que significa cada falla.