Eitri CLI¶

A Eitri CLI é o ponto de partida para desenvolver Eitri-Apps. Com ela você pode criar, desenvolver, testar e publicar Eitri-Apps para as aplicações de sua organização.

Requisitos¶

Para utilizar a Eitri CLI você precisará ter instalado em sua máquina:

• Node 18 ou superior
• NPM
• Git

Instalação¶

npm install -g eitri-cli

Atualização¶

Para atualizar a sua CLI, utilize o comando eitri self-update.

Comandos disponíveis¶

Adicione --help ou -h ao final de qualquer comando para ver como utilizá-lo e todas as suas opções. A maioria dos comandos só pode ser executada após o eitri login.

login¶

eitri login [opções]

Efetua o login na plataforma Eitri, salvando as credenciais da sua conta em sua máquina e vinculando a CLI à sua conta de desenvolvedor Eitri.

Opções¶

create¶

eitri create [opções] <nome-do-projeto>

Cria um novo projeto de Eitri-App em sua máquina e o registra na plataforma Eitri.

Você precisará fornecer algumas informações ao criar um Eitri-App:

Aplicação : Aplicação na qual seu Eitri-App irá rodar.

Nome legível : Nome utilizado na listagem do Console. É usado internamente e não é exibido aos usuários.

Nome para divulgação : Nome do produto, utilizado na divulgação e nos pontos de contato com o usuário. Este nome poderá ser visualizado pelos usuários.

Nome único : Também chamado de slug, identifica o Eitri-App de forma única na plataforma Eitri e é usado para referenciá-lo em diversos lugares, inclusive em deeplinks. Não pode se repetir entre Eitri-Apps e não deve conter espaços nem caracteres especiais.

Opções¶

eitri create meu-eitri-app --template

start¶

eitri start [opções]

Inicia o Eitri-App para desenvolvimento em um workspace online e exibe um QR Code para ser escaneado com o app de sua organização (ou com o Eitri Play).

À medida que você salva seus arquivos, o Eitri-App é recarregado (hot-reload) e as alterações aparecem em tempo real no seu aparelho.

Opções¶

Atalhos de teclado¶

Com o eitri start ou o eitri app start em execução, digite uma tecla no terminal e pressione enter:

No eitri app start, as teclas a, i, q e r perguntam qual Eitri-App do app-config.yaml você quer usar.

Parâmetros de inicialização¶

Os parâmetros de inicialização permitem abrir o Eitri-App em um cenário específico (um produto, um usuário, uma rota) sem alterar o código. Dentro do Eitri-App, leia-os com Eitri.getInitializationInfos(), que os retorna já convertidos em objeto:

const params = await Eitri.getInitializationInfos();
// --initialization-params 'productId=123&[email protected]'
// params => { productId: "123", email: "[email protected]" }

eitri start --initialization-params 'productId=123&[email protected]'

initialization-params:
  type: "string"
  value: "productId=123&[email protected]"

Alterando os parâmetros em execução¶

Você não precisa parar e rodar o start de novo para testar outros parâmetros. Digite p no terminal e pressione enter:

Depois de alterar, a CLI publica os novos parâmetros. Escaneie o QR Code novamente ou reabra o Eitri-App pelo deeplink para aplicá-los.

Veja o guia de parâmetros de inicialização para mais exemplos.

push-version¶

eitri push-version [opções]

Envia uma versão do seu Eitri-App para o Console. A versão fica disponível para publicação nos ambientes cadastrados para a aplicação.

Opções¶

publish¶

eitri publish --environment <id-do-ambiente> [opções]

Publica a versão atual do Eitri-App, definida no eitri-app.conf.js, no ambiente selecionado.

Opções¶

test¶

eitri test [opções]

Executa os testes do seu Eitri-App. Veja Testes.

Opções¶

clean¶

eitri clean [opções]

Realiza a limpeza do seu workspace remoto.

Ao rodar o eitri start, seu workspace é montado com o código da sua máquina e atualizado à medida que você salva seus arquivos. Se algo der errado na compilação em nuvem, o eitri clean ajuda a restabelecê-lo.

Opções¶

workspace¶

eitri workspace <comando> [opções]

Gerencia seus workspaces, permitindo utilizar mais de um.

Opções do use¶

app¶

eitri app <comando> [opções]

Executa e gerencia os Eitri-Apps do aplicativo declarado no arquivo app-config.yaml.

app start¶

eitri app start [opções]

Inicia todos os Eitri-Apps do app-config.yaml. O QR Code abre o Eitri-App marcado como focus. Os atalhos de teclado e os parâmetros de inicialização funcionam da mesma forma que no eitri start.

app logs¶

eitri app logs

Exibe os logs dos Eitri-Apps em execução pelo eitri app start.

app clean¶

eitri app clean [opções]

Realiza a limpeza completa dos workspaces, removendo tanto os workspaces remotos quanto as pastas .workspaces/ locais de todos os apps do app-config.yaml. Útil para resolver conflitos ou dados inválidos nos workspaces.

app create¶

eitri app create [opções] <nome-do-aplicativo>

Cria um aplicativo com vários Eitri-Apps, baseado em um template selecionado.

app snapshot¶

eitri app snapshot [opções]

Cria um snapshot do código-fonte do aplicativo, gerando um link e um QR Code para testar uma funcionalidade antes de publicá-la. Veja Snapshots.

Simulação da Bottom Bar¶

Enquanto desenvolve com o Eitri Play você pode simular a Bottom Bar e seus comportamentos. Confira aqui como simulá-la.

dependencies¶

eitri dependencies <comando> [opções]

Gerencia as dependências do Eitri-App. Veja Dependências.

Opções do docs¶

agents¶

eitri agents <comando> [opções]

Gerencia os agentes de IA do Eitri-App. Para entender o que os agentes podem fazer no seu app e qual modo de integração escolher, veja AI Agents.

Opções do setup¶

eitri agents setup --env workspace --llm <llm> --model <modelo> --api-key <api-key>

libs¶

eitri libs [opções]

Lista as versões das bibliotecas Eitri.

doctor¶

eitri doctor

Verifica as dependências e configurações da sua máquina para garantir que tudo está pronto para o desenvolvimento de Eitri-Apps.

self-update¶

eitri self-update

Atualiza a Eitri CLI, desinstalando versões anteriores e instalando a versão estável mais recente.

Manter a CLI atualizada garante o melhor desempenho, compatibilidade, estabilidade e experiência de desenvolvimento.