- Visão geral
- Introdução
- Conceitos
- Usando o UiPath CLI
- UiPath para agentes de codificação
- Guias de instruções
- Receitas de CI/CD
- Referência de comando
- Visão geral
- Códigos de saída
- Opções globais
- Agente de código uip
- Documento da UIP
- adicionar-tipo-dados-de-teste
- adicionar-dados-de-teste-fila
- adicionar-teste-variação de dados
- Analisar
- Criar
- criar projeto
- Comparação
- encontrar atividades
- obter-analisador-regras
- obter-padrão-atividade-xaml
- obter-erros
- obter-casos-de-teste-manuais
- obter-etapas-de-teste-manual
- Obter versões
- obter-fluxo-de-trabalho-exemplo
- indicar aplicativo
- indicar elemento
- inspecionar pacote
- instalar-data-fabric-entities
- instalar-ou-atualizar pacotes
- listar-data-fabric-entities
- listar-exemplos-de-fluxo-de-trabalho
- Empacotar
- restore
- arquivo de execução
- modelos-pesquisar
- Iniciar Studio
- interromper a execução
- UIA
- Traces da UIP
- Migração
- Referência e suporte
Guia do usuário da UiPath CLI
uip agent file opera nos arquivos individuais dentro de um projeto do Studio Web — o pai granular de uip agent pull / push, que movem arquivos .uis inteiros. Use file quando você quiser ler ou substituir um arquivo específico (por exemplo, patch agent.json no local) sem extrair e reempacotar toda a solução.
Cada subcomando requer uma sessão de CLI ativa (uip login). Todos os subcomandos respeitam as opções globais (--output, --output-filter, --log-level, --log-file). Os códigos de saída seguem o contrato padrão.
Resumo
uip agent file list <projectId> [--login-validity <minutes>]
uip agent file get <projectId> <fileId> [-d <path>] [--login-validity <minutes>]
uip agent file put <projectId> <fileId> <localPath> [--login-validity <minutes>]
uip agent file list <projectId> [--login-validity <minutes>]
uip agent file get <projectId> <fileId> [-d <path>] [--login-validity <minutes>]
uip agent file put <projectId> <fileId> <localPath> [--login-validity <minutes>]
<projectId> um UUID de projeto do Studio Web — o projeto interno dentro de uma solução, não a solução em si. Obtenha um do campo CloudProjectId de uip agent push, da matriz projects[] em uip agent list ou de SolutionStorage.json em um projeto enviado.
lista de arquivos do agente uip
Liste os arquivos dentro de um projeto do Studio Web como uma árvore mesclada.
Argumentos
<projectId>(necessário) — UUID do projeto do Studio Web.
Opções
| Bandeira | Padrão | Finalidade |
|---|---|---|
--login-validity <minutes> | 10 | Mínimo de minutos de validade do token necessários. |
Exemplo
uip agent file list a1b2c3d4-0000-0000-0000-000000000001
uip agent file list a1b2c3d4-0000-0000-0000-000000000001
Formato dos dados (--output json)
{
"Code": "AgentFileList",
"Data": [
{
"Path": "Agent/agent.json",
"Id": "a1b2c3d4-0000-0000-0000-000000000201",
"Name": "agent.json",
"FileType": "json",
"IsMain": "true",
"IsEntryPoint": "true"
}
]
}
{
"Code": "AgentFileList",
"Data": [
{
"Path": "Agent/agent.json",
"Id": "a1b2c3d4-0000-0000-0000-000000000201",
"Name": "agent.json",
"FileType": "json",
"IsMain": "true",
"IsEntryPoint": "true"
}
]
}
Path o caminho completo separado por barras a partir da raiz do projeto, incluindo os nomes das pastas aninhadas. IsMain e IsEntryPoint são booleanos com strings ("true" / "false"). Os projetos vazios retornam Data: { "Message": "No files found in project" }.
Obtenção de arquivo do agente uip
Baixe um único arquivo. Grave-o no disco ou codifique-o em base64 na resposta.
Argumentos
<projectId>(necessário) — UUID do projeto.<fileId>(necessário) — UUID do arquivo (defile list).
Opções
| Bandeira | Padrão | Finalidade |
|---|---|---|
-d, --destination <path> | — (escrever na resposta) | Caminho local no qual gravar o arquivo. O diretório pai é criado automaticamente. |
--login-validity <minutes> | 10 | Mínimo de minutos de validade do token necessários. |
Exemplos
# Download to a specific file path
uip agent file get \
a1b2c3d4-0000-0000-0000-000000000001 \
a1b2c3d4-0000-0000-0000-000000000201 \
-d ./agent.json
# Fetch without writing to disk (content is inlined base64)
uip agent file get \
a1b2c3d4-0000-0000-0000-000000000001 \
a1b2c3d4-0000-0000-0000-000000000201
# Download to a specific file path
uip agent file get \
a1b2c3d4-0000-0000-0000-000000000001 \
a1b2c3d4-0000-0000-0000-000000000201 \
-d ./agent.json
# Fetch without writing to disk (content is inlined base64)
uip agent file get \
a1b2c3d4-0000-0000-0000-000000000001 \
a1b2c3d4-0000-0000-0000-000000000201
Formato dos dados (--output json)
With -d
{
"Code": "AgentFileGet",
"Data": {
"Status": "File downloaded",
"ProjectId": "a1b2c3d4-0000-0000-0000-000000000001",
"FileId": "a1b2c3d4-0000-0000-0000-000000000201",
"Output": "/abs/path/agent.json"
}
}
{
"Code": "AgentFileGet",
"Data": {
"Status": "File downloaded",
"ProjectId": "a1b2c3d4-0000-0000-0000-000000000001",
"FileId": "a1b2c3d4-0000-0000-0000-000000000201",
"Output": "/abs/path/agent.json"
}
}
Sem -d (em linha):
{
"Code": "AgentFileGet",
"Data": {
"Status": "File downloaded",
"ProjectId": "…",
"FileId": "…",
"Content": "<base64>",
"Encoding": "base64"
}
}
{
"Code": "AgentFileGet",
"Data": {
"Status": "File downloaded",
"ProjectId": "…",
"FileId": "…",
"Content": "<base64>",
"Encoding": "base64"
}
}
arquivo uip do agente colocado
Carregar/substituir um arquivo em um projeto do Studio Web. O arquivo é enviado como dados de formulário multiparte para PUT /api/Project/<projectId>/FileOperations/File/<fileId>.
Argumentos
<projectId>(necessário) — UUID do projeto.<fileId>necessário) — UUID do arquivo a ser substituído.<localPath>necessário) — Caminho do arquivo local para carregar.
Opções
| Bandeira | Padrão | Finalidade |
|---|---|---|
--login-validity <minutes> | 10 | Mínimo de minutos de validade do token necessários. |
Exemplo
uip agent file put \
a1b2c3d4-0000-0000-0000-000000000001 \
a1b2c3d4-0000-0000-0000-000000000201 \
./agent.json
uip agent file put \
a1b2c3d4-0000-0000-0000-000000000001 \
a1b2c3d4-0000-0000-0000-000000000201 \
./agent.json
Formato dos dados (--output json)
{
"Code": "AgentFilePut",
"Data": {
"Status": "File uploaded",
"ProjectId": "a1b2c3d4-0000-0000-0000-000000000001",
"FileId": "a1b2c3d4-0000-0000-0000-000000000201",
"LocalPath": "/abs/path/agent.json"
}
}
{
"Code": "AgentFilePut",
"Data": {
"Status": "File uploaded",
"ProjectId": "a1b2c3d4-0000-0000-0000-000000000001",
"FileId": "a1b2c3d4-0000-0000-0000-000000000201",
"LocalPath": "/abs/path/agent.json"
}
}
Relacionado
uip agent pull— baixe toda a solução como um arquivo.uis.uip agent push— importar um projeto (novo ou substituir).uip agent list— enumerar soluções (e seus projetos).
Veja também
- Autenticação — sessões e
--login-validity. - Opções globais, Códigos de saída.
- Resumo
- lista de arquivos do agente uip
- Argumentos
- Opções
- Exemplo
- Formato dos dados (--output json)
- Obtenção de arquivo do agente uip
- Argumentos
- Opções
- Exemplos
- Formato dos dados (--output json)
- With
-d - arquivo uip do agente colocado
- Argumentos
- Opções
- Exemplo
- Formato dos dados (--output json)
- Relacionado
- Veja também