Práca z príkazového riadka

Príkazom codexis-agent-cli spravujete projekty, chaty a uložených agentov a posielate otázky s prílohami. Potrebujete dostupný spustiteľný príkaz, Node.js 22 alebo 24 a API kľúč k účtu s aktívnou licenciou CODEXIS AI Agent. Otázky čerpajú kredity vlastníka kľúča.

Príklady používajú Bash alebo Zsh. Dostupnosť príkazu overíte lokálne:

codexis-agent-cli --help

Prihlásenie a profilyCopy Anchor Link

API kľúč získate podľa návodu k API. Pri prihlásení ho zadajte do skrytého vstupu. CLI kľúč overí a uloží spolu s adresou do chráneného miestneho profilu.

codexis-agent-cli auth login --profile work --endpoint https://vm.codexis.ai
codexis-agent-cli auth status
codexis-agent-cli auth profile list

Adresu zadajte ako origin https://vm.codexis.ai, cestu /api/v2 dopĺňa CLI. Profil prepnete nasledujúcim príkazom; prepínač --profile work vyberie profil len pre jedno spustenie.

codexis-agent-cli auth profile use work
codexis-agent-cli auth status --profile work

V skripte môžete odovzdať kľúč a adresu premennými prostredia. V príklade obsahuje CI_API_KEY kľúč dodaný správcom tajných údajov. Tieto hodnoty majú pri spustení prednosť pred profilom a do profilu sa neukladajú.

CODEXIS_AGENT_API_KEY="$CI_API_KEY" \
CODEXIS_AGENT_ENDPOINT="https://vm.codexis.ai" \
codexis-agent-cli auth status --json --no-input

Na výslovné uloženie kľúča zo štandardného vstupu slúži prihlásenie s --token-stdin. Uložený profil odstránite príkazom nižšie.

codexis-agent-cli auth logout --profile old-profile

Projekt a prvý chatCopy Anchor Link

Vytvorte projekt z JSON na štandardnom vstupe. Odpoveď uložíte a z jej skutočného id nastavíte premennú pre ďalšie príkazy.

codexis-agent-cli project create --input - --json > project.json <<'JSON'
{
  "name": "Kontrola zmlúv",
  "description": "Podklady na právnu kontrolu",
  "instructions": "Upozorni na riziká a uveď zdroje.",
  "desktopFolders": [],
  "driveFolders": []
}
JSON
PROJECT_ID=$(node -p "JSON.parse(require('node:fs').readFileSync('project.json', 'utf8')).id")
codexis-agent-cli chat create --project "$PROJECT_ID" --title "Prvá kontrola" --json > chat.json
CHAT_ID=$(node -p "JSON.parse(require('node:fs').readFileSync('chat.json', 'utf8')).id")

Premenné nastavujte až po úspešnom vytvorení. Chat je pripravený na odoslanie prvej správy. Pri vytvorení môžete vybrať model pomocou --model; bez neho sa použije vaše predvolené nastavenie.

Existujúci projekt upravíte exportom jeho editovateľných polí. V súbore zmeňte hodnoty a až potom spustite aktualizáciu. Tá nahrádza všetkých päť polí: name, description, instructions, desktopFolders a driveFolders.

codexis-agent-cli project get "$PROJECT_ID" --editable --json > project-edit.json

codexis-agent-cli project update "$PROJECT_ID" --input project-edit.json

Správa s prílohou a priebežná odpoveďCopy Anchor Link

Pripravte miestny súbor zmluva.pdf. UUID požiadavky vytvorte pred odoslaním a ponechajte si ho pre prípad prerušenia spojenia.

REQUEST_ID=$(node -p "require('node:crypto').randomUUID()")
codexis-agent-cli chat send "$CHAT_ID" \
  --message "Zhrň zmluvu a upozorni na riziká." \
  --file ./zmluva.pdf \
  --idempotency-key "$REQUEST_ID" \
  --wait

--file pridáva prílohu a môžete ho opakovať. Text správy možno načítať pomocou --message-file zadanie.txt alebo zo štandardného vstupu pomocou --message-file -. Pre už nahranú prílohu použite --attachment-id s jej skutočným ID.

S --wait pribúda text odpovede na štandardnom výstupe. Potvrdenie prijatia a stav behu sa vypisujú na chybový výstup. Bez --wait príkaz vráti potvrdenie prijatia, ktoré obsahuje requestId, chatId, userMessageId a assistantMessageId.

Obnova požiadavky a sledovanieCopy Anchor Link

Pri neistom výsledku odoslania najprv vyhľadajte pôvodnú požiadavku. Použite rovnaké CHAT_ID a REQUEST_ID, ktoré ste uchovali pred odoslaním.

codexis-agent-cli chat request get "$CHAT_ID" "$REQUEST_ID" --json > receipt.json

Stav accepted potvrdzuje prijatie a vracia assistantMessageId. rejected obsahuje dôvod odmietnutia. Pri unresolved znova overte pôvodnú požiadavku; nové UUID by označovalo inú požiadavku. Aj po chybe spojenia najprv overte prijatie, kým správu odošlete znova.

Ak je stav accepted, prevezmite ID odpovede a pokračujte v sledovaní:

MESSAGE_ID=$(node -p "JSON.parse(require('node:fs').readFileSync('receipt.json', 'utf8')).assistantMessageId")
codexis-agent-cli chat watch "$CHAT_ID" --message "$MESSAGE_ID" --deadline 600

Ctrl-C alebo uplynutie --deadline ukončí sledovanie; vzdialený agent pokračuje. Predvolená lehota sledovania je 600 sekúnd. Na zastavenie behu pošlite výslovnú požiadavku a následne overte stav, pretože prijatie zastavenia ešte neznamená dokončené zastavenie.

codexis-agent-cli chat stop "$CHAT_ID" --message "$MESSAGE_ID"
codexis-agent-cli chat status "$CHAT_ID" --message "$MESSAGE_ID" --json

Výstup pre skriptyCopy Anchor Link

--json vracia jeden výsledný JSON objekt. Pri odoslaní s --wait obsahuje receipt a záverečný snapshot; pri sledovaní samotnú záverečnú snímku. --jsonl pri sledovaní priebežne vypisuje objekty snapshot a nakoniec result, prípadne error. Príkaz chat send --wait --jsonl pred nimi vypíše aj potvrdenie accepted.

codexis-agent-cli chat watch "$CHAT_ID" --message "$MESSAGE_ID" --jsonl
codexis-agent-cli project list --limit 20 --json --read-only

V skripte kontrolujte aj návratový kód. Kód 5 a chyba INPUT_REQUIRED znamenajú, že agent čaká na odpoveď alebo rozhodnutie. --no-input vypína interaktívne otázky CLI. --read-only zakáže zmeny vzdialených dát, čítanie a sledovanie ponechá dostupné.

Uloženie a použitie agentaCopy Anchor Link

Najprv vyberte agenta a do AGENT_ID uložte jeho presné id z výpisu. Zachovajte celý identifikátor vrátane prípadného prefixu. Polia editable a deletable hovoria, ktoré definície môžete zmeniť alebo zmazať; výpis zahŕňa aj agentov z doplnkov.

codexis-agent-cli agent list --all --json

Export vytvorí úplný JSON na editáciu. Upravte ho v editore a aktualizáciu spustite samostatne.

codexis-agent-cli agent get "$AGENT_ID" --editable --json > agent.json

codexis-agent-cli agent update "$AGENT_ID" --input agent.json

Zmenou name na nový názov a následným vytvorením uložíte vlastnú kópiu. Príkazy na vytvorenie aj aktualizáciu prijímajú aj --input - pre JSON zo štandardného vstupu. Zachovajte všetky polia exportu; lokalizácie sa pri aktualizácii zlučujú podľa jazyka a prázdne zoznamy ukážkových otázok zachovávajú doterajšie hodnoty.

codexis-agent-cli agent create --input agent.json --json > created-agent.json
AGENT_ID=$(node -p "JSON.parse(require('node:fs').readFileSync('created-agent.json', 'utf8')).id")

Pri vytvorení chatu --agent prevezme nastavenie modelu a jurisdikcií agenta. Jeho inštrukcie pre konkrétnu správu vyberiete prepínačom --agent-id pri odosielaní; ten môžete opakovať pre viacerých agentov.

codexis-agent-cli chat create --agent "$AGENT_ID" --json > agent-chat.json
AGENT_CHAT_ID=$(node -p "JSON.parse(require('node:fs').readFileSync('agent-chat.json', 'utf8')).id")
codexis-agent-cli chat send "$AGENT_CHAT_ID" --agent-id "$AGENT_ID" --message "Prever zadanie." --wait

Vlastnú definíciu odstránite nasledujúcim príkazom. Pred spustením overte zvolený identifikátor.

codexis-agent-cli agent delete "$AGENT_ID"

Otázky, automatizácie a čiastkoví agentiCopy Anchor Link

Ak agent čaká na vstup, načítajte otázky alebo návrhy automatizácií pre presnú odpoveď. Pri otázke prevezmite z výpisu toolCallId a revision. Pri automatizácii získate z výpisu toolCallId a revíziu až z detailu cez chat workflow get.

codexis-agent-cli chat question list "$CHAT_ID" --message "$MESSAGE_ID" --json
codexis-agent-cli chat workflow list "$CHAT_ID" --message "$MESSAGE_ID" --json

Do TOOL_CALL_ID a REVISION nastavte skutočné hodnoty vybranej otázky. Odpoveď na otázku odošlite napríklad textom:

codexis-agent-cli chat question answer "$CHAT_ID" "$TOOL_CALL_ID" \
  --message "$MESSAGE_ID" --revision "$REVISION" --text "Použi slovenské právo."

Pri automatizácii najprv načítajte detail. Po jeho posúdení zvoľte approve, request-changes s --feedback alebo cancel; všetky rozhodovacie príkazy vyžadujú prečítanú revíziu. Čiastkových agentov môžete vypísať, načítať ich detail príkazom get, správy príkazom messages alebo ich sledovať príkazom watch.

codexis-agent-cli chat workflow get "$CHAT_ID" "$TOOL_CALL_ID" --message "$MESSAGE_ID" --json
codexis-agent-cli chat workflow approve --help
codexis-agent-cli chat subagent list "$CHAT_ID" --message "$MESSAGE_ID" --json
codexis-agent-cli chat subagent watch --help

Katalógy a ďalšie príkazyCopy Anchor Link

Modely, jurisdikcie, nástroje a šablóny automatizácií nájdete v katalógoch. model get vracia detail modelu; model configure overuje voľby a odhad nákladov. Jeho --field key=value možno opakovať alebo odovzdať JSON cez --input.

codexis-agent-cli model list --json
codexis-agent-cli model configure --help
codexis-agent-cli jurisdiction list --json
codexis-agent-cli tool list --json
codexis-agent-cli workflow template list --json
codexis-agent-cli auth features --json

Stránkované zoznamy vracajú nextCursor. Pri pokračovaní ho odovzdajte pomocou --cursor s rovnakými filtrami. Ďalšie príkazy a ich povinné argumenty zobrazíte pridaním --help, napríklad pri chat, project chats alebo attachment upload.

Kam pokračovaťCopy Anchor Link

Dátové objekty a operácie opisuje REST API v2. Na pripojenie nástrojov do inej AI aplikácie pokračujte návodom k MCP.