title | weight | description |
---|---|---|
Executar uma fórmula "Hello World" |
25 |
Nesta seção, você encontrará o passo a passo para executar nosso "Hello World". |
{{% alert color="info" %}} Premissa: Depois de finalizar os passos anteriores - instalação e inicialização -, para acessar a fórmula hello world para testar o Ritchie, será necessário adicionar o repositório ritchie-formulas-demo localmente. {{% /alert %}}
Para fazer isso, você pode usar o comando rit add repo
, ou executar a linha de comando abaixo:
rit add repo --provider=Github --name=demo --repoUrl=https://github.com/ZupIT/ritchie-formulas-demo --priority=1
{{% alert color="info" %}}
É possível ainda verificar os repositórios estão sendo usados executando o comando rit list repo
.
{{% /alert %}}
Agora que você adicionou o repositório de demo, você pode executar os comandos desse tutorial.
Para obter os detalhes de uso de uma fórmula, é possível executar o comando usando a flag --help
.
rit demo hello-world --help
O retorno informará todas as flags disponíveis para a execução do comando.
No Ritchie, é possível, você tem 6 possibilidades de rodar uma fórmula através dessas flags:
- Via Prompt
- Via Prompt e Docker
- Via Input Flags
- Via Input Flags e Docker
- Via Stdin
- Via Stdin e Docker
Para isso, escreva um dos comandos abaixo:
{{% alert color="info" %}} Como essa fórmula foi desenvolvida usando Golang, é preciso ter Golang instalado para conseguir executá-la localmente. {{% /alert %}}
rit demo hello-world
Selecione uma opção para cada parâmetro de entrada e veja a mágica acontecer:
Essa é a execução padrão de linhas de comando no Ritchie, executando fórmulas localmente através de prompt (interagindo com o CLI no terminal) para informar os parâmetros de entrada.
Você pode rodar o mesmo comando usando a flag --docker para executar a fórmula remotamente (em um container), mas ainda informando os parâmetros de entrada via prompt:
rit demo hello-world --docker
{{% alert color="warning" %}} O Docker precisa estar instalado e iniciado para conseguir executar comandos usando essa flag. Nesse caso, não é necessário ter Golang instalado. {{% /alert %}}
Você também pode executar o comando informando as entradas por meio de flags (você pode saber quais flags estão disponíveis usando a flag --help
ao executar um comando). Desta forma, os parâmetros de entradas são informados diretamente na linha de comando.
rit demo hello-world --rit_input_text=Dennis --rit_input_boolean=true --rit_input_list=everything --rit_input_password=Ritchie
Ao combinar os input flags
com a flag do --docker
, é possível executar um comando remotamente (em um contêiner) com os parâmetros de entrada informados diretamente na linha de comando:
rit demo hello-world --rit_input_text=Dennis --rit_input_boolean=true --rit_input_list=everything --rit_input_password=Ritchie --docker
É também possível executar comando usando a flag --stdin
(Standard Input). Dessa maneira, os parâmetros de entrada podem ser informados diretamente na linha de comando inicial:
echo '{"rit_input_text":"Dennis", "rit_input_boolean":"true", "rit_input_list":"everything", "rit_input_password":"Ritchie"}' | rit demo hello-world --stdin
{{% alert color="warning" %}} Ritchie usa o formato JSON para executar comandos STDIN. {{% /alert %}}
Quando são usadas as 2 flags --stdin e --docker, é possível executar o comando remotamente informando os parâmetros de entrada na linha de comando inicial, sem necessidade de ação humana:
echo '{"rit_input_text":"Dennis", "rit_input_boolean":"true", "rit_input_list":"everything", "rit_input_password":"Ritchie"}' | rit demo hello-world --stdin --docker
{{% alert color="info" %}} Dê uma olhada nas fórmulas da comunidade (ex: ritchie-formulas). A maioria das fórmulas tem um arquivo README explicando como executar a fórmula e para que ela serve. {{% /alert %}}
Nessa seção, você viu como executar uma fórmula no Ritchie. Para continuar aprendendo:
-
Confira agora as fórmulas que você tem acesso usando o comando:
-
Veja como criar suas fórmulas .