1 of 20
2 of 20
3 of 20
4 of 20
5 of 20
6 of 20
7 of 20
8 of 20
9 of 20
10 of 20
11 of 20
12 of 20
13 of 20
14 of 20
15 of 20
16 of 20
17 of 20
18 of 20
19 of 20
20 of 20

doc

Primeiros passos

Neste tutorial você aprenderá como instalar e começar a usar a Azion CLI.

Nota: com a finalidade de simplificar o texto, a partir deste ponto a Azion CLI será citada apenas como CLI.

Instalação

Existem duas maneiras de instalar a CLI:

  • Utilizando gerenciadores de pacotes, como:
    • Homebrew4 Package Manager
    • RPM Package Manager (RPM)
    • Dpkg Package Manager (Dpkg)
    • Alpine Package Keeper (apk)
  • Instalando a CLI manualmente.

Para instalar a CLI utilizando os gerenciadores de pacotes, siga os seguintes passos:

  1. Para utilizar os gerenciadores de pacotes RPM, Dpkg, e apk, acesse a nossa página de releases e faça o download do pacote desejado. Se você escolher essa opção, pode pular para o passo 3.
  2. Para utilizar o Homebrew, visite o site oficial do instalador de pacotes e siga as instruções de instalação localizadas na sua homepage.

    Nota: não há necessidade de fazer download de pacotes pela nossa página de releases como no passo 1.

  3. Execute o comando da coluna Comando de Instalação da tabela abaixo referente ao pacote de instalação escolhido. A CLI será instalada automaticamente.

    Nota: nos comandos de instalação dos gerenciadores de pacotes RPM, Dpkg, e apk, substitua o placeholder <downloaded_file> pelo arquivo do pacote de instalação baixado no passo 1. No caso do gerenciador de pacotes Homebrew, apenas execute o comando exatamente como apresentado na tabela.

    Gerenciador de pacotes Site Documentação Comando de instalação
    Homebrew Homebrew package manager Homebrew documentação de suporte brew install aziontech/tap/azioncli
    RPM RPM package manager RPM documentação de suporte sudo rpm -i <downloaded_file>
    Dpkg Debian® 5 operating system Dpkg documentação de suporte sudo dpkg -i <downloaded_file>
    apk Alpine Linux® 6operating system apk documentação de suporte apk add <downloaded_file>
  4. Execute o comando azioncli --version para testar a instalação. A CLI apresenta no terminal o número da versão recém instalada no seu computador.

Alternativamente, visite os sites dos gerenciadores de pacotes utilizando os links da tabela do passo 3 e siga as instruções de instalação clicando nos links da coluna Documentação.

Para instalar a CLI manualmente, siga os seguintes passos:

  1. Crie uma pasta no sistema de arquivos do seu computador na qual deseja executar os comandos da CLI; por exemplo: my-cli.

    Dica: você pode criar uma pasta em seu sistema de arquivos diretamente usando o terminal. Para fazer isso, execute o comando mkdir my-cli, no qual my-cli é o nome da pasta.

  2. Faça o download do binário da arquitetura desejada, cujas plataformas compatíveis estão listadas abaixo; o arquivo binário azioncli é baixado na pasta Downloads do sistema de arquivos do computador.

    Sistema Operacional Arquitetura URL da Azion CLI
    macOS x86_64 https://downloads.azion.com/darwin/x86_64/azioncli
    macOS ARM64 https://downloads.azion.com/darwin/arm64/azioncli
    FreeBSD® 7 x86_64 https://downloads.azion.com/freebsd/x86_64/azioncli
    FreeBSD ARM64 https://downloads.azion.com/freebsd/arm64/azioncli
    Linux® 8 x86_32 https://downloads.azion.com/linux/x86_32/azioncli
    Linux x86_64 https://downloads.azion.com/linux/x86_64/azioncli
    Linux ARM32 https://downloads.azion.com/linux/arm32/azioncli
    Linux ARM64 https://downloads.azion.com/linux/arm64/azioncli

    Como alternativa, você pode fazer o download via linha de comando. No exemplo abaixo, o link é referente à arquitetura Linux/x86_64. Caso utilize outra versão, basta alterar a URL para o sistema operacional ou arquitetura desejada com o comando abaixo:

    curl -O https://downloads.azion.com/linux/x86_64/azioncli

  3. Copie o arquivo azioncli, baixado no passo anterior, para a pasta criada no passo 1 com o gerenciador de arquivos do seu sistema operacional.

  4. Abra o terminal e mude o diretório de trabalho para a pasta que você criou no passo 1 executando o comando cd <path> com o caminho da pasta my-cli no seu computador.

    Dica: você pode abrir diretamente o terminal com o path completo de uma pasta arrastando-a a partir do gerenciador de arquivos do seu sistema operacional até o ícone do aplicativo terminal. Essa dica funciona na maioria dos sistemas operacionais.

  5. Confirme a existência do arquivo binário azioncli na pasta do projeto com o comando ls.

    Resposta no terminal:

     azioncli
    
  6. Conceda permissão para execução do binário azioncli no seu computador com o seguinte comando:

           chmod +x azioncli

    Se o terminal não apresentar nenhuma mensagem, isso significa que o comando foi executado sem erros.

    Nota: caso o seu computador utilize o sistema operacional macOS, ele apresentará uma janela com uma mensagem de erro impedindo a execução da CLI. Veja o procedimento para liberar a execução da CLI no sistema operacional macOS, apresentado mais adiante.

  7. Execute o comando:

    Nota: o comando abaixo permite que você execute a azioncli a partir de qualquer pasta do sistema de arquivos do seu computador. Você poderá então apagar os arquivos azioncli no diretório do seu projeto e da pasta Downloads, executando o comando rm azioncli nos respectivos diretórios.

    sudo cp azioncli /usr/local/bin

    O comando acima é opcional. Caso você não queria executar o comando sudo cp azioncli /usr/local/bin, lembre-se de ter uma cópia do binário azioncli na pasta do seu projeto e executá-la com os caracteres ./ na frente, como em ./azioncli <command>. Caso contrário, uma mensagem de erro será apresentada informando que o comando azioncli não foi encontrado.

    O comando sudo pede a senha do usuário com poderes de administrador do computador. Digite a sua senha e pressione a tecla ENTER ou RETURN. Os caracteres não são exibidos durante a digitação.

  8. Teste a execução da CLI com o comando a seguir; uma tela de ajuda será apresentada no monitor.

    azioncli --help

    Resposta da CLI:

     Usage:
     azioncli <command> <subcommand> [flags]
     azioncli [flags]
     	
     azioncli [command]
    
     Available Commands:
     configure      Authorizes connections with Azion platform’s services
     edge_functions Manages your Azion account's Edge Functions
     edge_services  Manages your Azion account's Edge Services
     help           Help about any command
     version        Returns the CLI version
     edge_applications         Creates edge applications on Azion's platform
    
     Flags:
     -h, --help      Displays more information about the Azion CLI
     -v, --version   version for azioncli
    
     Use "azioncli [command] --help" for more information about a command.
    

    Caso uma janela com uma mensagem de alerta seja exibida na tela, informando que o desenvolvedor não pode ser identificado, clique no botão Cancelar. O terminal responde com a seguinte mensagem:

     zsh: killed     azioncli --help
    

    Em seguida, siga os passos do tópico Execução da CLI no Sistema Operacional macOS. Após liberar a execução, execute novamente o comando azioncli --help ou azioncli --version para verificar se a Azion CLI está funcionando normalmente. No caso do comando azioncli --version, a resposta deverá ser semelhante a apresentada abaixo, ou uma versão superior:

     azioncli version 0.46.0  
    

    Nota: o processo de liberação da execução da CLI apresentado acima é referente ao sistema operacional macOS. Caso utilize outro sistema operacional, siga os procedimentos previstos na documentação do sistema.

Pronto! A partir de agora você já pode executar comandos da CLI. Para auxiliá-lo, ela possui um sistema interativo e integrado de ajuda com o propósito de facilitar a sua utilização.

No tópico seguinte você aprenderá como liberar o uso da Azion CLI no sistema operacional macOS, caso ainda não tenha realizado essa configuração.

1.2 Execução da CLI no sistema operacional macOS

Para liberar a execução da CLI no seu computador, siga os seguintes passos:

Nota: o menu Apple3 é o pequeno logo da empresa Apple Inc. company, localizado no canto superior esquerdo da tela do seu computador Mac.

  1. Acesse menu Apple > Preferências do Sistema.
  2. Na janela Preferências do Sistema, selecione a seção Segurança e Privacidade.
  3. Selecione a guia Geral, caso ainda não esteja selecionada; você visualizará uma mensagem indicando o impedimento da execução da CLI.
  4. Clique no botão Permitir Mesmo Assim.

    Nota: na próxima vez que você executar um comando da CLI, o sistema operacional macOS abrirá uma janela de confirmação informando que não pode verificar o desenvolvedor da azioncli.

  5. Execute o comando abaixo para forçar o aparecimento da janela de confirmação:

    azioncli --help

  6. Clique no botão Abrir na janela de confirmação.

O comando azioncli --help será executado, e você não precisará repetir esses procedimentos novamente. Uma vez configurado, o acesso à CLI se tornará permanente no sistema operacional macOS do seu computador.

Caso o seu computador utilize outro sistema operacional, verifique os procedimentos necessários na documentação correspondente.

Além da autorização no sistema operacional, você também precisará gerenciar os seus Personal Tokens para executar certos comandos da CLI. Como eles, você autoriza a execução dos comandos na plataforma da Azion. Veja o tópico a seguir.

Autorização na Plataforma da Azion

Para administrar as suas configurações, você deve gerar um token que o identifique na plataforma da Azion. Caso contrário, a CLI apresentará uma mensagem de erro no terminal informando que o token é inválido ou está expirado.

Veja o exemplo a seguir, no qual utilizamos o comando configure para configurar um token inexistente:

azioncli configure --token mytokennaAzion123

Como o tokenmytokennaAzion123” não existe, a CLI apresenta a seguinte mensagem de erro:

Usage:
  azioncli configure [flags]

Examples:
$ azioncli configure --help
$ azion configure --token azionxxxxxxxxxxxxxxxx

Flags:
  -h, --help           Displays more information about the configure command
  -t, --token string   Saves a given personal token locally to authorize CLI commands

Error: The provided token is invalid. You must create a new token and configure it to use with the CLI. Manage your personal tokens on RTM using the Account Menu > Personal Tokens and configure the new token with the command 'azioncli configure --token <new_token>'

Note que a CLI não apresenta apenas a mensagem de erro. Para lhe ajudar, ela divide o texto em três partes distintas:

  1. Usage - a sintaxe do comando.
  2. Flags - os modificadores do comando.
  3. Error - a mensagem de erro em si.

O erro Invalid token ocorre sempre que um token inválido é usado em determinados comandos CLI.

Para mais informações sobre como criar e gerenciar os seus tokens pessoais, utilize nossa API ou a página Personal Tokens de nossa documentação.

Você pode armazenar localmente um token existente e válido utilizando o seguinte comando:

azioncli configure --token <seu_token>

Todos os comandos subsequentes utilizarão esse mesmo token e serão consideradas todas as permissões concedidas à conta que esse token pertence.

Você pode substituir o seu Personal Token a qualquer momento repetindo o mesmo comando acima.

Colocando em prática a Azion CLI

A fim de observar na prática o funcionamento da CLI, vamos utilizar como exemplo as Edge Functions. É comum uma Edge Application utilizar diversas funções presentes numa Edge Library.

Nota: o exemplo a seguir visa apenas apresentar uma breve introdução da CLI. Os comandos serão detalhados posteriormente ao longo desta documentação.

Neste exemplo, você poderá facilmente:

  • Listar as Edge Functions constantes na sua Edge Library.
  • Criar uma nova função.
  • Excluir uma função existente.

Dica: para visualizar as suas Edge Functions atuais, acesse o menu do Real-Time Manager (RTM) e selecione Edge Functions na seção EDGE LIBRARIES. A função Azion - Hello World já está disponível por padrão para que você possa praticar, mesmo que você ainda não tenha criado nenhuma Edge Function.

Nota: caso a sua conta no RTM seja antiga, pode ser que a função Azion - Hello World não esteja disponível.

Inicialmente, você pode listar as Edge Functions disponíveis na sua biblioteca, incluindo a função pré-configurada Azion - Hello World.

Pré-requisitos: para os exemplos a seguir, é necessário que você:

  • Instale a Azion CLI.
  • Crie ou utilize um Personal Token que o identifique na plataforma da Azion.

Para listar as suas Edge Functions, execute o comando abaixo:

azioncli edge_functions list

Uma lista com as suas funções será exibida no monitor, como neste exemplo:

ID      NAME                   LANGUAGE      ACTIVE
3976    Azion - Hello World    javascript    true
6598    func01                 javascript    true

Observe que o comando azioncli edge_functions list respondeu com uma tabela composta por quatro colunas:

  • ID: identificador único da Edge Function na Azion.
  • NAME: nome da função.
  • LANGUAGE: linguagem de programação ou framework da função.
  • ACTIVE: status da função, podendo se ativo (true) ou inativo (false).

Neste exemplo, a tabela é composta de duas funções:

  • Azion - Hello World, ID 3976.
  • func01, ID 6598.

Conforme citado anteriormente, a função Azion - Hello World já estava previamente disponível na biblioteca. Observe também que as duas funções foram desenvolvidas na linguagem de programação JavaScript9, e que ambas estão ativas no momento.

Vamos agora criar uma nova Edge Function diretamente pela CLI, sem precisar recorrer ao RTM. Inicialmente, vamos precisar de um arquivo JavaScript contendo o código da função. Caso você não tenha um arquivo no diretório atual, crie um de forma prática e direta com o comando abaixo:

echo "alert('Minha nova função JavaScript');" > my-func.js

Depois de executar o comando, verifique a criação do arquivo my-func.js com o comando ls.

Agora que você já tem um arquivo com a função JavaScript, poderá criar a sua Edge Function com ele. Para isso, digite o comando abaixo:

azioncli edge_functions create --name my-new-ef --code ./my-func.js --active true

Resposta da CLI:

Created Edge Function with ID 6823

A CLI responde com o ID da nova função criada. Para verificar, vamos utilizar novamente o comando list:

azioncli edge_functions list

Resposta da CLI:

ID      NAME                   LANGUAGE      ACTIVE
3976    Azion - Hello World    javascript    true
6598    func01                 javascript    true
6823    my-new-ef              javascript    true

Observe que, em relação à lista do exemplo anterior, desta vez o comando list incluiu a função my-new-ef com o ID 6823, criada pelo comando create.

Vamos agora excluir a recém-criada função my-new-ef. Para isso, execute o comando delete com o parâmetro ID da função:

azioncli edge_functions delete --function-id 6823

Resposta da CLI:

Edge Function 6823 was successfully deleted

Execute novamente o comando list. A CLI apresentará a seguinte tabela:

ID      NAME                   LANGUAGE      ACTIVE
3976    Azion - Hello World    javascript    true
6598    func01                 javascript    true

Note que a função my-new-ef, cujo ID era 6823, não aparece mais na lista. Como sugestão, você pode acessar o RTM a fim de analisar os resultados dos comandos da CLI apresentados neste exemplo simples.

Utilizando a funcionalidade Autocomplete

A funcionalidade Autocomplete da Azion CLI aumenta a produtividade ao digitar comandos, especialmente naqueles que são mais extensos.

Por exemplo, ao invés de digitar o comando azioncli, você poderá simplesmente digitar az, seguido da tecla tab. O texto do comando será automaticamente completado.

Para instalar a funcionalidade Autocomplete da CLI, visite o tópico Setup Autocomplete.

Dica: depois de instalar o Autocomplete, lembre-se de reiniciar o terminal para ativar a funcionalidade.

Realize alguns testes para se familiarizar com o Autocomplete. Veja como digitar rapidamente o comando azioncli edge_applications init com pouco esforço:

Nota: o símbolo → equivale à tecla tab no teclado.

      azwi

O resultado será o texto azioncli edge_applications init com o pressionar de apenas sete teclas em vez de 20, tendo em vista que a funcionalidade inclui um espaço em branco automaticamente após cada comando.

Caso o complemento do texto tenha mais de uma opção de comando ou subcomando, o Autocomplete mostra automaticamente uma lista de opções ao pressionar a tecla →. Tente o exemplo abaixo:

      aze → →

user@computer ~ % azioncli edge_
edge_functions  -- Manages your Azion account's Edge Functions
edge_services   -- Manages your Azion account's Edge Services

Note que, ao teclar o último →, o Autocomplete apresenta uma lista com dois subcomandos e suas respectivas short descriptions. Para selecionar um deles, pressione repetidamente a tecla → até escolher o subcomando desejado. Em seguida, pressione a tecla espaço no teclado para finalizar a inserção do comando.

Agora é só você usufruir da praticidade e funcionalidade do Autocomplete para agilizar o desenvolvimento dos seus projetos com a Azion CLI!

Você chegou ao final deste tutorial introdutório da Azion CLI. Acompanhe nos guias específicos de cada comando explicações mais detalhadas sobre como explorar todas as potencialidades da CLI.


Não encontrou o que procurava? Abra um ticket.