UiPath Documentation
uipath-cli
latest
false
Importante :
Este conteúdo foi traduzido com auxílio de tradução automática. A localização de um conteúdo recém-publicado pode levar de 1 a 2 semanas para ficar disponível.

Guia do usuário da UiPath CLI

Última atualização 22 de mai de 2026

uip platform

uip platform is the Platform tool: it manages organization- and tenant-level license resources — tenant runtime/consumable allocations, per-user license bundles, group allocation rules, and the organization-wide consumables report. Install it with uip tools install platform, or invoke uip platform … and let auto-install run. See Tools (plugins) for the install model and uip tools for the command that manages tool installation.

Recursos

Cada recurso tem sua própria página de referência. O verbo definido em cada página corresponde aos comandos registrados por uip platform — execute uip platform --help para confirmar a superfície completa em sua instalação.

RecursoFinalidade
TenantsGet the license summary for a tenant; set runtime licenses and consumables, routed to the service license that already owns each product code.
usuáriosAllocate user-bundle licenses to a directory user, list a user's current leases (direct or group-inherited), and view the account-level user-bundle availability.
GruposList, inspect, and configure group license-allocation rules with optional per-bundle quotas.
LicençasOrganization-level consumables reporting: per-tenant allocation summary, daily breakdown by service, and per-folder breakdown.

Resumo

uip platform <resource> <verb> [options]
uip platform <resource> <verb> [options]

Sempre uip platform, nunca uip plt. platform é o prefixo de comando da ferramenta (consulte a coluna commandPrefix em uip tools list).

Como ler esta seção

Cada página de recurso é estruturada da mesma maneira:

  1. Resumo — a forma de comando uip platform <resource> <verb> .
  2. Verbos — uma tabela de uma linha de cada verbo que o recurso expõe.
  3. One H2 per verb — description, positional arguments (if any), flag table, an example, and the Data shape returned under --output json.
  4. Exit codes — a pointer to the shared Exit codes contract.
  5. Comandos relacionados e Consulte também — links cruzados para recursos irmãos e páginas de conceito relevantes.

O formato de saída padrão é --output json. As formas de dados em cada página refletem a carga JSON — as renderizações de tabela, yaml e simples são derivadas do mesmo objeto Data .

Sinalizadores comuns

uip platform verbs share one optional org-scoping flag. Identifier flags (<tenant-key>, <user>, <group>) are positional and documented per verb.

BandeiraUsado porFinalidade
--organization <account-id>cada verboOrganization account GUID. Defaults to the org from the current login. Override when an external app or session is scoped to a different account.

Verb-level flags (--input, --mode, --tenant, --unit, --start-date, --end-date, --limit, --offset, --sort-by, --sort-order) are documented on each resource page.

Opções globais e códigos de saída

Todos os verbos uip platform respeitam as quatro opções globais (--output, --output-filter, --log-level, --log-file). Os códigos de saída seguem o contrato compartilhado.

Veja também

  • Conceitos: como o UiPath CLI é organizado — onde as ferramentas se encaixam no modelo de host + ferramenta.
  • Sessions — how the organization context is resolved.
  • Configuração — variáveis de ambiente e arquivos de configuração que afetam cada ferramenta.
  • uip or licenses — Orchestrator-level robot license assignment (machine and named-user), complementary to platform-level allocation.

Esta página foi útil?

Conectar

Precisa de ajuda? Suporte

Quer aprender? Academia UiPath

Tem perguntas? Fórum do UiPath

Fique por dentro das novidades