Configuração do CLI

Esta seção abrange como autenticar e configurar o re. Assume-se que você tenha instalado a CLI; consulte as instruções de instalação .

A seção de configuração rápida é uma pequena referência passo a passo sobre como começar e configurar a CLI. O resto da página contém instruções detalhadas e entra em todas as opções disponíveis.

Configuração rápida

Instale a ferramenta de linha de comando para sua plataforma (Linux, Mac e Windows são suportados).

Crie um contexto nomeado para evitar ter que inserir seu endpoint do tenant e o token da API toda vez. Forneça ao ponto de extremidade do tenant:

re config add --name main --endpoint https://<my_api_endpoint>/

Será solicitado que você cole o token da API:

I A new context `main` will be created.
  Enter API token [none]: MYSUPERSECRETTOKEN
I New context `main` was created.

Tente executar um comando para ver tudo funciona, por exemplo

re get datasets

Você pode usar o sinalizador global -c ou --context para usar um contexto específico com o comando, por exemplo,

re -c main get datasets

Qualquer uma das configurações de contexto pode ser substituída como uma única usando sinalizadores globais, como --token, --endpoint e --proxy etc. Os argumentos de linha de comando têm precedência sobre as configurações de contexto.

Fornecer credenciais todas as vezes

A maneira mais simples de autenticar a CLI é especificar o ponto de extremidade e o token da API para cada comando. Por padrão, re solicitará que você insira o token interativamente.

Por exemplo, para listar os conjuntos de dados disponíveis

➜ re --endpoint https://acme.reinfer.io get datasets
input: Enter API token [none]: MYSUPERSECRETAPITOKEN
 Name                                ID                Updated (UTC)        Title
 InvestmentBank/collateral-streams  aa9dda7c059e5a8d  2019-04-30 17:25:03  IB Collateral Streams
 InvestmentBank/george-test          1aaeacd49dfce8a0  2019-05-10 15:32:34  Test Dataset
 InvestmentBank/margin-call          b9d50fb2b38c3af5  2019-05-08 07:51:09  IB Margin Call
 InvestmentBank/margin-call-large    6d00b9f69ab059f6  2019-05-11 09:23:43  IB Margin Call Large

O token também pode ser especificado usando --token

➜ re --endpoint https://acme.reinfer.io --token MYSUPERSECRETAPITOKEN get datasets

Isso geralmente não é uma boa ideia, pois o token da API será armazenado em seu histórico de shell. Seria melhor armazenar o token de API em uma variável de ambiente.

➜ re --endpoint https://acme.reinfer.io --token $REINFER_TOKEN get datasets

No entanto, isso ainda é detalhado, repetitivo e inseguro.

AVISO:

Fornecer configuração usando sinalizadores de linha de comando pode ser útil em alguns casos. No entanto, a maneira recomendada de usar a CLI é configurando um contexto nomeado; veja abaixo.

Contextos nomeados

Um contexto é uma coleção de configurações e credenciais que você pode aplicar a um comando re . Quando você especifica um contexto para executar um comando, as configurações e credenciais são usadas para executar esse comando. Vários contextos podem ser armazenados no arquivo de configuração.

Os contextos ajudam a evitar ter que especificar manualmente um token, ponto de extremidade e outras configurações com cada comando. Um contexto é composto de:

• Um nome fácil de lembrar que serve como identificador do contexto
• Um token de API usado para autenticar o usuário que faz solicitações
• Um endpoint para o qual a CLI fará as solicitações
• (Opcional) Um proxy HTTP a ser usado para todas as solicitações
• (Opcional) Aceitar certificados TLS inválidos do endpoint (útil apenas para clusters do Communications Mining internos/dev)

Você pode especificar um contexto padrão que é usado quando nenhum é referenciado explicitamente.

O sinalizador global -c, --context pode ser usado para usar um contexto específico com nomes que você pode especificar como um parâmetro na linha de comando para comandos individuais.

Criação de um contexto

Você pode criar um novo contexto ou modificar um existente com

re config add

Se for executado sem opções, o comando pedirá interativamente o nome do contexto, o ponto de extremidade e o token.

➜ re config add
* Context name: acme-prod
I A new context `acme-prod` will be created
* Enter API token [none]: MYSUPERSECRETTOKEN
* Endpoint [https://reinfer.io/]: https://acme.reinfer.io
I Default context set to `acme-prod`
I New context `acme-prod` was created

Ao criar o primeiro contexto, este será definido como o ativo

➜ re config add --name acme-dev --endpoint https://acme.reinfer.io/
I A new context `acme-dev` will be created.
* Enter API token [none]: MYSUPERSECRETTOKEN
I Default context set to `acme-dev`
I New context `acme-dev` was created.

Ao invés disso, adicionar um contexto com um nome que já existe atualizará esse contexto.

# Edit the acme-dev context if it already exists
re config add acme-dev

Para ver todas as opções, execute re config add -h. As mais importantes são

Opções

Nome	Descrição
--name <name>	O nome do contexto que será criado ou atualizado
--endpoint <endpoint>	O endpoint do cluster do Communications Mining que será usado para este contexto
--token <token>	O token da API reinfer que será usado para este contexto
--proxy <proxy>	URL de um proxy HTTP que será usado para todas as solicitações se especificado

O contexto atual será usado para todos os comandos subsequentes. O seguinte imprimirá todos os conjuntos de dados para o contexto atual .

re get datasets

Qualquer uma das configurações de contexto pode ser substituída como uma única usando sinalizadores globais, como --token, --endpoint e --proxy.

re --proxy http://proxy.example get datasets

Usar um contexto

Você pode usar o sinalizador global -c ou --context para usar um contexto específico com o comando, por exemplo,

re -c my-context get datasets

reconfigurar

Todas as operações relacionadas ao gerenciamento de contextos nomeados têm o escopo sob o comando re config . Os subcomandos permitem criar, atualizar, definir contextos padrão e excluir, e mais.

Consulte a referência de comando para todas as opções disponíveis.

Onde as definições de configuração são armazenadas?

A localização do seu diretório de configuração varia com base no sistema operacional. A ferramenta de linha de comando do Communications Mining respeita esses padrões do sistema operacional e, normalmente, o diretório de configuração pode ser encontrado em

• ~/.config/reinfer no Linux
• $HOME/.config/reinfer no macOS
• %AppData%\reinfer no Windows

As configurações de contexto são armazenadas em um arquivo JSON contexts.json, por exemplo ~/.config/reinfer/contexts.json no Linux. É parecido com isto

{
  "current_context": "prod",
  "contexts": [
    {
      "name": "prod",
      "endpoint": "https://acme.reinfer.io/",
      "token": "MYSUPERSECRETTOKEN",
      "accept_invalid_certificates": false,
      "proxy": null
    }
  ]
}