Configurar la CLI

This section covers how to authenticate and configure re. It assumes you have installed the CLI. For more details, check the installation instructions.

The quick setup section is a short step-by-step reference for how to get started and configure the CLI. The rest of the page contains detailed instructions and goes into all of the available options.

Configuración rápida

Install the command line tool for your platform (Linux, Mac, and Windows are supported).

Create a named context to avoid having to enter your tenant endpoint and API token every time. Provide your tenant endpoint:

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

You will be asked to paste your API token:

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

Intente ejecutar un comando para comprobar que todo funciona, por ejemplo

re get datasets

Puedes usar el marcador global -c o --context para usar un contexto específico con el comando, por ejemplo

re -c main get datasets

Cualquiera de los ajustes de contexto puede sobrescribirse como único utilizando indicadores globales como --token, --endpoint y --proxy , etc. Los argumentos de la línea de comandos tienen prioridad sobre los ajustes de contexto.

Suministrar credenciales cada vez

La forma más sencilla de autenticar la CLI es especificar el punto final y el token de la API para cada comando. De forma predeterminada, re te pedirá que introduzcas el token de forma interactiva.

Por ejemplo, para enumerar los conjuntos de datos disponibles

➜ 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

El token también se puede especificar utilizando --token

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

Por lo general, esto no es una buena idea, ya que el token de la API se almacenará en tu historial de shell. Sería mejor almacenar el token de la API en una variable de entorno.

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

Sin embargo, esto sigue siendo detallado, repetitivo e inseguro.

ADVERTENCIA:

Proporcionar la configuración mediante marcadores de línea de comandos puede ser útil en algunos casos. Sin embargo, la forma recomendada de utilizar la CLI es configurando un contexto con nombre. Para obtener más información, consulta la siguiente sección.

Contextos con nombre

Un contexto es una colección de ajustes y credenciales que puedes aplicar a un comando re . Cuando especificas un contexto para ejecutar un comando, la configuración y las credenciales se utilizan para ejecutar ese comando. Se pueden almacenar varios contextos en el archivo de configuración.

Los contextos ayudan a evitar tener que especificar manualmente un token, un punto final y otra configuración con cada comando. Un contexto se compone de:

• Un nombre fácil de recordar que sirve como identificador para el contexto
• Un token de API utilizado para autenticar al usuario que realiza las solicitudes
• Un punto final al que la CLI realizará las solicitudes
• (Opcional) Un proxy HTTP para todas las solicitudes
• (Opcional) Si se aceptan certificados TLS no válidos desde el punto final (solo es útil para clústeres internos/de desarrollo de Communications Mining™)

Puedes especificar un contexto predeterminado que se utiliza cuando no se hace referencia explícita a ninguno.

El marcador global -c, --context puede utilizarse para utilizar un contexto específico con nombres que puedes especificar como parámetro en la línea de comandos para comandos individuales.

Crear un contexto

Puedes crear un nuevo contexto o modificar uno existente con

re config add

Si se ejecuta sin opciones, el comando solicitará de forma interactiva el nombre del contexto, el punto final y el 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

Al crear el primer contexto, este se establecerá como el activo

➜ 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.

Añadir un contexto con un nombre que ya existe actualizará ese contexto.

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

Para ver todas las opciones, ejecuta re config add -h. Los más importantes son:

Opciones

Nombre	Descripción
--name <name>	El nombre del contexto que se creará o actualizará
--endpoint <endpoint>	El punto final del clúster de Communications Mining™ que se utilizará para este contexto
--token <token>	El token API de reinferencia que se utilizará para este contexto
--proxy <proxy>	URL de un proxy HTTP que se utilizará para todas las solicitudes si se especifica

El contexto actual se utilizará para todos los comandos posteriores. Lo siguiente imprimirá todos los conjuntos de datos para el contexto actual .

re get datasets

Cualquiera de los ajustes de contexto se puede sobrescribir como único utilizando indicadores globales como --token, --endpoint y --proxy.

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

Usar un contexto

Puedes usar el marcador global -c o --context para usar un contexto específico con el comando, por ejemplo

re -c my-context get datasets

volver a configurar

Todas las operaciones relacionadas con la gestión de contextos con nombre están en el ámbito del comando re config . Los subcomandos permiten crear, actualizar, establecer los contextos predeterminados y eliminar, y mucho más.

For all the available options, check the command reference.

¿Dónde se almacenan los ajustes de configuración?

La ubicación de tu directorio de configuración varía en función del sistema operativo. La herramienta de línea de comandos Communications Mining™ respeta estos valores predeterminados del sistema operativo y, por lo general, el directorio de configuración se puede encontrar en

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

La configuración de contexto se almacena en un archivo JSON contexts.json, por ejemplo ~/.config/reinfer/contexts.json en Linux. Se parece a esto

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