Skip to content

Commit 598ff8f

Browse files
vldcmp-uipathclaude
andcommitted
docs: document uipath new project types and agent frameworks
Add the missing `new` section to the CLI reference (mkdocs-click block plus type semantics, behaviour matrix, and function/agent examples), an --agent-framework column and Claude Agent SDK row to the coded-agents framework table, explicit-type notes to the agents and Studio Web quickstarts, a --type function guarantee note to the coded-functions guide, and uipath-claude-sdk to the Studio Web package lists. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
1 parent 26b489e commit 598ff8f

4 files changed

Lines changed: 90 additions & 10 deletions

File tree

‎packages/uipath/docs/cli/index.md‎

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -67,6 +67,61 @@ Treat `--client-secret` as a credential. In CI, prefer reading it from a secret
6767

6868
---
6969

70+
::: mkdocs-click
71+
:module: uipath._cli
72+
:command: new
73+
:depth: 1
74+
:style: table
75+
76+
Scaffolds a project in the current directory. `--type` selects what gets created:
77+
78+
- **`auto`** (default) — an installed agent framework integration (e.g. `uipath-langchain`) claims the scaffold and creates a coded agent project; with none installed, a coded function project is created.
79+
- **`function`** — always creates a coded function project, regardless of installed integrations.
80+
- **`agent`** — creates a coded agent project. `--agent-framework` picks the framework and defaults to the one whose integration package is installed.
81+
82+
| Installed framework integrations | `uipath new x` (auto) | `uipath new x --type agent` |
83+
|----------------------------------|------------------------|------------------------------|
84+
| none | coded function project | error listing the integration packages |
85+
| one | that framework's coded agent project | that framework's coded agent project |
86+
| several | error: pick one explicitly | error: pick one explicitly |
87+
88+
`--agent-framework` is only valid together with `--type agent`.
89+
90+
Scaffold a coded function:
91+
92+
<!-- termynal -->
93+
94+
```shell
95+
> uipath new my-function --type function
96+
⠋ Creating new project my-function in current directory ...
97+
✓ Created 'main.py' file.
98+
✓ Created 'pyproject.toml' file.
99+
✓ Created 'uipath.json' file.
100+
💡 Initialize project: uipath init
101+
💡 Run project: uipath run main '{"message": "Hello World!"}'
102+
```
103+
104+
Scaffold a coded agent — requires the framework's integration package in the environment:
105+
106+
<!-- termynal -->
107+
108+
```shell
109+
> uv add uipath-langchain
110+
Resolved 42 packages in 1.2s
111+
Installed 42 packages in 0.8s
112+
113+
> uipath new my-agent --type agent
114+
Using the installed 'langchain' agent framework.
115+
⠋ Creating new agent my-agent in current directory ...
116+
✓ Created 'main.py' file.
117+
✓ Created 'langgraph.json' file.
118+
✓ Created 'pyproject.toml' file.
119+
💡 Initialize project: uipath init
120+
💡 Run agent: uipath run agent '{"topic": "UiPath"}'
121+
```
122+
123+
---
124+
70125
::: mkdocs-click
71126
:module: uipath._cli
72127
:command: init

‎packages/uipath/docs/core/agents.md‎

Lines changed: 19 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -17,14 +17,17 @@ Every coded agent is built from two layers:
1717

1818
The `uipath` package is always required. Add one framework extension on top:
1919

20-
| Framework | Package | Best for |
21-
|-----------|---------|---------|
22-
| LangChain / LangGraph | `uipath-langchain` | Graph-based agents, complex multi-step flows |
23-
| LlamaIndex | `uipath-llamaindex` | RAG-heavy agents, document reasoning |
24-
| OpenAI Agents SDK | `uipath-openai-agents` | OpenAI-native tool use, handoffs |
25-
| PydanticAI | `uipath-pydantic-ai` | Type-safe agents with Pydantic models |
26-
| Google ADK | `uipath-google-adk` | Gemini models, Google ecosystem |
27-
| UiPath Agent Framework | `uipath-agent-framework` | UiPath-native agent primitives |
20+
| Framework | Package | `--agent-framework` | Best for |
21+
|-----------|---------|---------------------|---------|
22+
| LangChain / LangGraph | `uipath-langchain` | `langchain` | Graph-based agents, complex multi-step flows |
23+
| LlamaIndex | `uipath-llamaindex` | `llamaindex` | RAG-heavy agents, document reasoning |
24+
| OpenAI Agents SDK | `uipath-openai-agents` | `openai-agents` | OpenAI-native tool use, handoffs |
25+
| PydanticAI | `uipath-pydantic-ai` | `pydantic-ai` | Type-safe agents with Pydantic models |
26+
| Google ADK | `uipath-google-adk` | `google-adk` | Gemini models, Google ecosystem |
27+
| UiPath Agent Framework | `uipath-agent-framework` | `microsoft-agent-framework` | UiPath-native agent primitives |
28+
| Claude Agent SDK | `uipath-claude-sdk` | `claude-sdk` | Claude models, Anthropic-native agent loop |
29+
30+
The `--agent-framework` column is the value to pass to `uipath new --type agent` when scaffolding explicitly (see the note below the Quickstart).
2831

2932
---
3033

@@ -85,6 +88,14 @@ The example below uses LangChain. Swap `uipath-langchain` for the framework of y
8588

8689
////
8790

91+
/// info | Explicit project type and framework
92+
`uipath new` defaults to `--type auto`: the installed agent framework integration claims the scaffold, which is why the commands above create an agent project. To request one explicitly — required when several framework integrations are installed in the same environment — pass the type and framework:
93+
94+
```shell
95+
uipath new agent --type agent --agent-framework langchain
96+
```
97+
///
98+
8899
---
89100

90101
## Project Structure

‎packages/uipath/docs/core/functions.md‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -70,6 +70,14 @@ Use coded functions for deterministic compute steps: document extraction, ERP wr
7070

7171
////
7272

73+
/// info | Guaranteeing a function project
74+
`uipath new` defaults to `--type auto`: when an agent framework integration (e.g. `uipath-langchain`) is installed in the environment, it scaffolds a coded agent instead of a function. Pass `--type function` to always get a coded function project:
75+
76+
```shell
77+
uipath new my-function --type function
78+
```
79+
///
80+
7381
---
7482

7583
## Project Structure

‎packages/uipath/docs/core/studio_web.md‎

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -171,6 +171,7 @@ First, install the SDK package for the framework you want to use:
171171
# uipath-pydantic-ai - PydanticAI
172172
# uipath-google-adk - Google ADK
173173
# uipath-agent-framework - UiPath Agent Framework
174+
# uipath-claude-sdk - Claude Agent SDK
174175
> uv add uipath-langchain
175176
Resolved 42 packages in 1.2s
176177
Installed 42 packages in 0.8s
@@ -190,6 +191,7 @@ Installed 42 packages in 0.8s
190191
# uipath-pydantic-ai - PydanticAI
191192
# uipath-google-adk - Google ADK
192193
# uipath-agent-framework - UiPath Agent Framework
194+
# uipath-claude-sdk - Claude Agent SDK
193195
> pip install uipath-langchain
194196
Successfully installed uipath-langchain
195197
```
@@ -221,9 +223,13 @@ Selected tenant: Tenant1
221223

222224
That's it, your agent should now be visible in Studio Web.
223225
226+
/// info
227+
`uipath new` defaults to `--type auto`, which lets the installed framework integration claim the scaffold. With several integrations installed, pick one explicitly: `uipath new agent --type agent --agent-framework <framework>`.
228+
///
229+
224230
#### Coded Function
225231
226-
A coded function doesn't require an additional framework package. Authenticate, scaffold the project, and initialize it:
232+
A coded function doesn't require an additional framework package. Authenticate, scaffold the project, and initialize it (`--type function` guarantees a function project even when a framework integration is installed):
227233

228234
<!-- termynal -->
229235

@@ -238,7 +244,7 @@ Select tenant number: 0
238244
Selected tenant: Tenant1
239245
✓ Authentication successful.
240246
241-
> uipath new my-function
247+
> uipath new my-function --type function
242248
✓ Created 'main.py' file.
243249
✓ Created 'pyproject.toml' file.
244250
✓ Created 'uipath.json' file.

0 commit comments

Comments
 (0)