@piagent/platform 1.41.0 → 1.42.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +1020 -2038
- package/CONTRIBUTING.md +2 -0
- package/README.md +128 -325
- package/README.vi.md +149 -143
- package/docs/command-reference-vietnamese.md +2 -2
- package/docs/distribution-standard.md +6 -6
- package/docs/languages.json +2 -2
- package/docs/operator-manual-vietnamese.md +7 -7
- package/docs/publishing-for-teams.md +2 -0
- package/docs/release-install-policy.md +3 -3
- package/docs/team-onboarding.md +2 -2
- package/docs-site/architecture.html +71 -63
- package/docs-site/assets/docs.css +2736 -1030
- package/docs-site/assets/docs.js +451 -43
- package/docs-site/assets/og.png +0 -0
- package/docs-site/assets/piagent-logo.svg +9 -31
- package/docs-site/assets/search-en.json +1 -0
- package/docs-site/assets/search-vi.json +1 -0
- package/docs-site/benchmark.html +71 -63
- package/docs-site/commands.html +72 -64
- package/docs-site/content/en/index.html +220 -131
- package/docs-site/content/en/quickstart.html +74 -90
- package/docs-site/content/en/update.html +80 -0
- package/docs-site/content/en/whats-new.html +1 -684
- package/docs-site/content/index.html +220 -131
- package/docs-site/content/quickstart.html +73 -108
- package/docs-site/content/update.html +80 -0
- package/docs-site/content/whats-new.html +1 -684
- package/docs-site/context-engine.html +73 -65
- package/docs-site/ecosystem.html +73 -65
- package/docs-site/en/architecture.html +67 -59
- package/docs-site/en/benchmark.html +67 -59
- package/docs-site/en/commands.html +68 -60
- package/docs-site/en/context-engine.html +68 -60
- package/docs-site/en/ecosystem.html +68 -60
- package/docs-site/en/index.html +281 -220
- package/docs-site/en/mcp-approval.html +67 -59
- package/docs-site/en/mcp-auth.html +67 -59
- package/docs-site/en/mcp-servers.html +68 -60
- package/docs-site/en/mcp.html +64 -56
- package/docs-site/en/permissions.html +68 -60
- package/docs-site/en/profiles.html +68 -60
- package/docs-site/en/quickstart.html +142 -150
- package/docs-site/en/runtime.html +67 -59
- package/docs-site/en/scope.html +68 -60
- package/docs-site/en/security.html +64 -56
- package/docs-site/en/team.html +67 -59
- package/docs-site/en/update.html +228 -0
- package/docs-site/en/whats-new.html +1612 -725
- package/docs-site/en/windows.html +71 -63
- package/docs-site/en/workflows.html +68 -60
- package/docs-site/favicon.svg +9 -14
- package/docs-site/index.html +281 -220
- package/docs-site/mcp-approval.html +70 -62
- package/docs-site/mcp-auth.html +70 -62
- package/docs-site/mcp-servers.html +71 -63
- package/docs-site/mcp.html +70 -62
- package/docs-site/permissions.html +72 -64
- package/docs-site/profiles.html +72 -64
- package/docs-site/quickstart.html +145 -172
- package/docs-site/releases.json +4485 -0
- package/docs-site/runtime.html +73 -65
- package/docs-site/scope.html +73 -65
- package/docs-site/security.html +73 -65
- package/docs-site/team.html +71 -63
- package/docs-site/update.html +228 -0
- package/docs-site/whats-new.html +1616 -729
- package/docs-site/windows.html +75 -67
- package/docs-site/workflows.html +73 -65
- package/evals/private-holdout-v1/public-exposure.v2.json +1 -1
- package/package.json +1 -1
- package/packages/piagent-core/managed/dist/workspace/manifest.json +1 -1
- package/packages/piagent-core/managed/dist/workspace/worker.mjs +1 -1
- package/packages/piagent-core/package.json +1 -1
- package/packages/piagent-core/security/workspace-file-reader.ts +3 -1
- package/packages/piagent-webui/dist/client/assets/ActivityPanel-DRAiHliI.js +1 -0
- package/packages/piagent-webui/dist/client/assets/App-JMuP_9-r.js +5 -0
- package/packages/piagent-webui/dist/client/assets/GatewayApp-awcOLVTi.js +93 -0
- package/packages/piagent-webui/dist/client/assets/InspectionApp-DtDc9NxN.js +1 -0
- package/packages/piagent-webui/dist/client/assets/LineReview-DZ9ez8kO.js +3 -0
- package/packages/piagent-webui/dist/client/assets/{MarkdownMessage-DeLo-xiz.js → MarkdownMessage-D7bbIWJe.js} +2 -2
- package/packages/piagent-webui/dist/client/assets/SessionAgentWorkspace-DLwK12hX.js +1 -0
- package/packages/piagent-webui/dist/client/assets/SessionInspectorDrawer-CsPNI6aU.js +2 -0
- package/packages/piagent-webui/dist/client/assets/SettingsNavigation-CM0s3QUC.js +3 -0
- package/packages/piagent-webui/dist/client/assets/SettingsPage-Cr6M2FVg.js +1 -0
- package/packages/piagent-webui/dist/client/assets/TerminalPanel-A78JVp4e.js +2 -0
- package/packages/piagent-webui/dist/client/assets/{TerminalView-r9rG24IO.js → TerminalView-CR4TO5f1.js} +3 -3
- package/packages/piagent-webui/dist/client/assets/WorkspaceCodeEditor-DPOp-ZoD.js +2 -0
- package/packages/piagent-webui/dist/client/assets/WorkspaceExplorer-H8Ogln3d.js +5 -0
- package/packages/piagent-webui/dist/client/assets/WorkspaceQuickOpen-vQ5DqfJl.js +1 -0
- package/packages/piagent-webui/dist/client/assets/api-BUjrtT1B.js +1 -0
- package/packages/piagent-webui/dist/client/assets/composer-drafts-BtMaVw8W.js +1 -0
- package/packages/piagent-webui/dist/client/assets/index-Dqb2hNan.css +1 -0
- package/packages/piagent-webui/dist/client/assets/index-qi6mjvTy.js +37 -0
- package/packages/piagent-webui/dist/client/assets/latest-request-DXcYQW86.js +1 -0
- package/packages/piagent-webui/dist/client/assets/tab-close-DHDqCxTL.js +1 -0
- package/packages/piagent-webui/dist/client/assets/terminal-transport-Dk5pYNX5.js +1 -0
- package/packages/piagent-webui/dist/client/assets/transcript-view-model-BNGQCkzY.js +3 -0
- package/packages/piagent-webui/dist/client/assets/ui-preferences-Dy4qeODT.js +1 -0
- package/packages/piagent-webui/dist/client/assets/vendor-CA5pzJiI.js +136 -0
- package/packages/piagent-webui/dist/client/assets/view-model-CWNiS4JN.js +1 -0
- package/packages/piagent-webui/dist/client/assets/workspace-navigation-C8GtShbg.js +1 -0
- package/packages/piagent-webui/dist/client/index.html +4 -9
- package/packages/piagent-webui/gateway/signed-session-journal.ts +16 -6
- package/packages/piagent-webui/server/loopback-server.ts +19 -5
- package/packages/piagent-webui/server/static-bundle.ts +10 -2
- package/scripts/build-docs-site.mjs +205 -348
- package/scripts/check-public-wording.mjs +2 -1
- package/scripts/docs-site-icons.mjs +84 -0
- package/scripts/docs-site-nav.mjs +302 -0
- package/scripts/docs-site-releases.mjs +227 -0
- package/scripts/verify-local.sh +17 -1
- package/packages/piagent-webui/dist/client/assets/Alert-DGWhP2MM.js +0 -1
- package/packages/piagent-webui/dist/client/assets/Button-QItfZUNj.js +0 -1
- package/packages/piagent-webui/dist/client/assets/DialogTitle-CyaFPaiW.js +0 -3
- package/packages/piagent-webui/dist/client/assets/TerminalPanel-BG-DP_qm.js +0 -2
- package/packages/piagent-webui/dist/client/assets/Typography-B9om7Evq.js +0 -1
- package/packages/piagent-webui/dist/client/assets/WorkspaceCodeEditor-BnqaR3pK.js +0 -2
- package/packages/piagent-webui/dist/client/assets/WorkspaceExplorer-BIxwiGtl.js +0 -5
- package/packages/piagent-webui/dist/client/assets/WorkspaceQuickOpen-CK3dILhQ.js +0 -1
- package/packages/piagent-webui/dist/client/assets/index-DBUTrEXi.css +0 -1
- package/packages/piagent-webui/dist/client/assets/index-rlyRccut.js +0 -102
- package/packages/piagent-webui/dist/client/assets/tab-close-BoJRyBO_.js +0 -1
- package/packages/piagent-webui/dist/client/assets/ui-preferences-BO3AV7QE.js +0 -10
- package/packages/piagent-webui/dist/client/assets/useId-DEefKUAT.js +0 -124
|
@@ -1,251 +1,236 @@
|
|
|
1
1
|
<!doctype html>
|
|
2
|
-
<html lang="en" data-copy-success="Copied" data-copy-fallback="Select command">
|
|
2
|
+
<html lang="en" data-copy-success="Copied" data-copy-fallback="Select command" data-copy-label="Copy">
|
|
3
3
|
<head>
|
|
4
4
|
<meta charset="utf-8" />
|
|
5
5
|
<meta name="viewport" content="width=device-width, initial-scale=1" />
|
|
6
|
-
<title>
|
|
7
|
-
<meta name="description" content="
|
|
8
|
-
<meta name="theme-color" content="#
|
|
6
|
+
<title>Install and run your first turn · Pi Agent Platform</title>
|
|
7
|
+
<meta name="description" content="Two commands to install. Open a repository, pick its profile and permissions, then ask in plain language." />
|
|
8
|
+
<meta name="theme-color" content="#09090b" media="(prefers-color-scheme: dark)" />
|
|
9
|
+
<meta name="theme-color" content="#fbfbf9" media="(prefers-color-scheme: light)" />
|
|
9
10
|
<link rel="canonical" href="https://piagent.io.vn/en/quickstart" />
|
|
10
11
|
<link rel="alternate" hreflang="vi" href="https://piagent.io.vn/quickstart" />
|
|
11
12
|
<link rel="alternate" hreflang="en" href="https://piagent.io.vn/en/quickstart" />
|
|
12
13
|
<link rel="alternate" hreflang="x-default" href="https://piagent.io.vn/quickstart" />
|
|
13
14
|
<link rel="icon" href="/favicon.svg" type="image/svg+xml" />
|
|
14
|
-
<meta property="og:
|
|
15
|
-
<meta property="og:
|
|
15
|
+
<meta property="og:type" content="website" />
|
|
16
|
+
<meta property="og:title" content="Install and run your first turn · Pi Agent Platform" />
|
|
17
|
+
<meta property="og:description" content="Two commands to install. Open a repository, pick its profile and permissions, then ask in plain language." />
|
|
16
18
|
<meta property="og:url" content="https://piagent.io.vn/en/quickstart" />
|
|
19
|
+
<meta property="og:image" content="https://piagent.io.vn/assets/og.png" />
|
|
20
|
+
<meta name="twitter:card" content="summary_large_image" />
|
|
21
|
+
<script>try{var t=localStorage.getItem("piagent-docs-theme");if(t==="light"||t==="dark")document.documentElement.dataset.theme=t}catch(e){}</script>
|
|
17
22
|
<link rel="preconnect" href="https://fonts.googleapis.com" />
|
|
18
23
|
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin />
|
|
19
24
|
<link
|
|
20
|
-
href="https://fonts.googleapis.com/css2?family=
|
|
25
|
+
href="https://fonts.googleapis.com/css2?family=Inter:wght@400;450;500;550;600;650;700;750&family=JetBrains+Mono:wght@400;500;600;700&display=swap"
|
|
21
26
|
rel="stylesheet"
|
|
22
27
|
/>
|
|
23
28
|
<link rel="stylesheet" href="/assets/docs.css" />
|
|
24
29
|
<script src="/assets/docs.js" defer></script>
|
|
25
30
|
</head>
|
|
26
31
|
<body>
|
|
32
|
+
<svg width="0" height="0" style="position:absolute" aria-hidden="true"><symbol id="icon-apple" viewBox="0 0 24 24"><path d="M16 3.5c-1 .3-2.4 1.3-2.6 3 1.2.1 2.4-.8 2.6-3zM12 8c-1.5-1-5-1-6 2.5S6.5 19 9 20c1.2.5 2-.4 3-.4s1.8.9 3 .4c1.4-.6 2.5-2.7 3-4.5-2.5-1-2.8-4.6-.5-6-1.2-1.6-3.3-2-4.5-1.5z"/></symbol><symbol id="icon-branch" viewBox="0 0 24 24"><circle cx="6" cy="5.5" r="2"/><circle cx="6" cy="18.5" r="2"/><circle cx="18" cy="7.5" r="2"/><path d="M6 7.5v9M18 9.5c0 4.5-5 4-11 7.5"/></symbol><symbol id="icon-chart" viewBox="0 0 24 24"><path d="M4 4v16h16"/><path d="M8.5 16v-5M12.5 16V8M16.5 16v-3"/></symbol><symbol id="icon-cpu" viewBox="0 0 24 24"><rect x="6" y="6" width="12" height="12" rx="2"/><rect x="9.5" y="9.5" width="5" height="5" rx=".8"/><path d="M9 2.5V6M15 2.5V6M9 18v3.5M15 18v3.5M2.5 9H6M2.5 15H6M18 9h3.5M18 15h3.5"/></symbol><symbol id="icon-edit" viewBox="0 0 24 24"><path d="M4 20h4L19 9l-4-4L4 16z"/><path d="m13.5 6.5 4 4"/></symbol><symbol id="icon-github" viewBox="0 0 24 24"><path d="M9 19c-4.5 1.5-4.5-2.5-6.5-3m13 6v-3.5a3 3 0 0 0-.9-2.4c3-.3 6.4-1.5 6.4-6.7a5.2 5.2 0 0 0-1.4-3.6 4.8 4.8 0 0 0-.1-3.6s-1.1-.3-3.7 1.4a12.6 12.6 0 0 0-6.6 0C6.6 1.9 5.5 2.2 5.5 2.2a4.8 4.8 0 0 0-.1 3.6A5.2 5.2 0 0 0 4 9.4c0 5.2 3.4 6.4 6.4 6.7a3 3 0 0 0-.9 2.4V22"/></symbol><symbol id="icon-hash" viewBox="0 0 24 24"><path d="M5 9h15M4 15h15M10 3 8 21M16 3l-2 18"/></symbol><symbol id="icon-home" viewBox="0 0 24 24"><path d="M3 10.5 12 3l9 7.5V20a1 1 0 0 1-1 1h-5v-6H9v6H4a1 1 0 0 1-1-1z"/></symbol><symbol id="icon-key" viewBox="0 0 24 24"><circle cx="8" cy="15" r="4"/><path d="m10.9 12.1 8.6-8.6M16.5 6.5l2.5 2.5M14 9l2 2"/></symbol><symbol id="icon-layers" viewBox="0 0 24 24"><path d="m12 3 9 5-9 5-9-5z"/><path d="m3 13 9 5 9-5"/><path d="m3 17.5 9 5 9-5" opacity=".55"/></symbol><symbol id="icon-lock" viewBox="0 0 24 24"><rect x="4" y="11" width="16" height="10" rx="2"/><path d="M8 11V7a4 4 0 0 1 8 0v4"/></symbol><symbol id="icon-menu" viewBox="0 0 24 24"><path d="M4 7h16M4 12h16M4 17h16"/></symbol><symbol id="icon-moon" viewBox="0 0 24 24"><path d="M20 14.5A8 8 0 1 1 9.5 4a6.5 6.5 0 0 0 10.5 10.5z"/></symbol><symbol id="icon-network" viewBox="0 0 24 24"><circle cx="12" cy="5" r="2.5"/><circle cx="5" cy="19" r="2.5"/><circle cx="19" cy="19" r="2.5"/><path d="M12 7.5V12m0 0-5.2 5.2M12 12l5.2 5.2"/></symbol><symbol id="icon-plug" viewBox="0 0 24 24"><path d="M9 3v4M15 3v4M6 7h12v4a6 6 0 0 1-12 0zM12 17v4"/></symbol><symbol id="icon-refresh" viewBox="0 0 24 24"><path d="M20 11A8 8 0 0 0 5.3 6.7M4 3v4h4"/><path d="M4 13a8 8 0 0 0 14.7 4.3M20 21v-4h-4"/></symbol><symbol id="icon-rocket" viewBox="0 0 24 24"><path d="M5.5 15.5C4 17 3.5 19.5 3.5 20.5c1 0 3.5-.5 5-2"/><path d="M9 15 6.5 12.5C8 8.5 11.5 4.5 20 4c-.5 8.5-4.5 12-8.5 13.5z"/><circle cx="14.5" cy="9.5" r="1.5"/></symbol><symbol id="icon-search" viewBox="0 0 24 24"><circle cx="11" cy="11" r="7"/><path d="m20 20-3.5-3.5"/></symbol><symbol id="icon-server" viewBox="0 0 24 24"><rect x="3" y="4" width="18" height="7" rx="2"/><rect x="3" y="13" width="18" height="7" rx="2"/><path d="M7 7.5h.01M7 16.5h.01"/></symbol><symbol id="icon-shield" viewBox="0 0 24 24"><path d="M12 3 4.5 6v5.5c0 4.8 3.2 8.2 7.5 9.5 4.3-1.3 7.5-4.7 7.5-9.5V6z"/></symbol><symbol id="icon-shield-check" viewBox="0 0 24 24"><path d="M12 3 4.5 6v5.5c0 4.8 3.2 8.2 7.5 9.5 4.3-1.3 7.5-4.7 7.5-9.5V6z"/><path d="m9 12 2.2 2.2L15.5 10"/></symbol><symbol id="icon-sliders" viewBox="0 0 24 24"><path d="M4 7h9M17 7h3M4 17h3M11 17h9"/><circle cx="15" cy="7" r="2"/><circle cx="9" cy="17" r="2"/></symbol><symbol id="icon-sparkles" viewBox="0 0 24 24"><path d="M11 3c.6 4.6 2.4 6.4 7 7-4.6.6-6.4 2.4-7 7-.6-4.6-2.4-6.4-7-7 4.6-.6 6.4-2.4 7-7z"/><path d="M19 15v5M16.5 17.5h5"/></symbol><symbol id="icon-sun" viewBox="0 0 24 24"><circle cx="12" cy="12" r="4"/><path d="M12 2.5v2M12 19.5v2M4.6 4.6 6 6M18 18l1.4 1.4M2.5 12h2M19.5 12h2M4.6 19.4 6 18M18 6l1.4-1.4"/></symbol><symbol id="icon-target" viewBox="0 0 24 24"><circle cx="12" cy="12" r="9"/><circle cx="12" cy="12" r="5"/><circle cx="12" cy="12" r="1"/></symbol><symbol id="icon-terminal" viewBox="0 0 24 24"><rect x="3" y="4" width="18" height="16" rx="2.5"/><path d="m7.5 9.5 3 2.5-3 2.5M13 15h4"/></symbol><symbol id="icon-users" viewBox="0 0 24 24"><circle cx="9" cy="8" r="3.5"/><path d="M2.5 20a6.5 6.5 0 0 1 13 0"/><path d="M16 4.5a3.5 3.5 0 0 1 0 7M18 14a6 6 0 0 1 3.5 6"/></symbol><symbol id="icon-windows" viewBox="0 0 24 24"><path d="M3.5 5.5 10.5 4.5v7h-7zM13 4.2 20.5 3v8.5H13zM3.5 13h7v7l-7-1zM13 13h7.5v8.5L13 20.3z"/></symbol><symbol id="icon-wrench" viewBox="0 0 24 24"><path d="M15 6.5a4.5 4.5 0 0 1-6 6l-5 5L6.5 20l5-5a4.5 4.5 0 0 0 6-6L15 11.5l-2.5-2.5z"/></symbol></svg>
|
|
33
|
+
<a class="skip-link" href="#content">Skip to content</a>
|
|
27
34
|
<header class="topbar">
|
|
35
|
+
<button class="icon-button mobile-menu" type="button" data-menu aria-label="Open docs menu"><svg class="icon" viewBox="0 0 24 24" aria-hidden="true"><use href="#icon-menu"/></svg></button>
|
|
28
36
|
<a class="brand" href="/en/" aria-label="Pi Agent Platform">
|
|
29
|
-
<span class="brand-mark"><img src="/assets/piagent-logo.svg" alt="" /></span>
|
|
30
|
-
<span>
|
|
37
|
+
<span class="brand-mark"><img src="/assets/piagent-logo.svg" alt="" width="28" height="28" /></span>
|
|
38
|
+
<span class="brand-name"><b>Piagent</b> <span>Platform</span></span>
|
|
31
39
|
</a>
|
|
40
|
+
<a class="version-badge" href="/en/whats-new" data-docs-version="v1.42.1" title="v1.42.1 docs · EN"><span class="dot"></span>v1.42.1</a>
|
|
41
|
+
<nav class="top-nav" aria-label="Documentation">
|
|
42
|
+
<a href="/en/quickstart" aria-current="page">Docs</a>
|
|
43
|
+
<a href="/en/whats-new">Changelog</a>
|
|
44
|
+
<a href="/en/benchmark">Benchmark</a>
|
|
45
|
+
</nav>
|
|
46
|
+
<span class="top-spacer"></span>
|
|
47
|
+
<button class="search-trigger" type="button" data-search aria-label="Search documentation"><svg class="icon" viewBox="0 0 24 24" aria-hidden="true"><use href="#icon-search"/></svg><span>Search the docs…</span><kbd>⌘K</kbd></button>
|
|
32
48
|
<div class="top-actions">
|
|
33
|
-
<
|
|
34
|
-
<
|
|
35
|
-
|
|
36
|
-
<a class="language-option current" href="/en/quickstart" hreflang="en" lang="en" aria-current="true">EN</a>
|
|
37
|
-
</nav>
|
|
38
|
-
<a class="button social" href="https://github.com/Vt-mmm/piagent" target="_blank" rel="noopener noreferrer" aria-label="Open GitHub repository">
|
|
39
|
-
<svg viewBox="0 0 24 24" fill="none" aria-hidden="true">
|
|
40
|
-
<path d="M7 17 17 7M9 7h8v8" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" />
|
|
41
|
-
</svg>
|
|
42
|
-
GitHub
|
|
43
|
-
</a>
|
|
44
|
-
<button class="button mobile-menu" type="button" data-menu>Menu</button>
|
|
45
|
-
<a class="button top-command-link" href="/en/commands">Commands</a>
|
|
49
|
+
<nav class="language-switch" aria-label="Language"><a class="language-option" href="/quickstart" hreflang="vi" lang="vi">VI</a><a class="language-option current" href="/en/quickstart" hreflang="en" lang="en" aria-current="true">EN</a></nav>
|
|
50
|
+
<button class="icon-button theme-toggle" type="button" data-theme-toggle aria-label="Switch light/dark theme"><svg class="icon icon-moon" viewBox="0 0 24 24" aria-hidden="true"><use href="#icon-moon"/></svg><svg class="icon icon-sun" viewBox="0 0 24 24" aria-hidden="true"><use href="#icon-sun"/></svg></button>
|
|
51
|
+
<a class="icon-button" href="https://github.com/Vt-mmm/piagent" target="_blank" rel="noopener noreferrer" aria-label="Open GitHub repository"><svg class="icon" viewBox="0 0 24 24" aria-hidden="true"><use href="#icon-github"/></svg></a>
|
|
46
52
|
</div>
|
|
47
53
|
</header>
|
|
48
54
|
|
|
49
55
|
<div class="layout with-toc">
|
|
50
56
|
<aside class="sidebar" data-sidebar>
|
|
51
|
-
<div class="sidebar-search" aria-label="Search documentation">
|
|
52
|
-
<svg viewBox="0 0 24 24" fill="none" aria-hidden="true">
|
|
53
|
-
<path d="M10.8 18.1a7.3 7.3 0 1 1 0-14.6 7.3 7.3 0 0 1 0 14.6Zm5.3-1.7 4.4 4.4" stroke="currentColor" stroke-width="2" stroke-linecap="round" />
|
|
54
|
-
</svg>
|
|
55
|
-
<input type="search" placeholder="Search pages" data-filter />
|
|
56
|
-
</div>
|
|
57
|
-
|
|
58
57
|
<nav aria-label="Documentation">
|
|
59
58
|
<div class="nav-group">
|
|
60
59
|
<p class="nav-title">Get started</p>
|
|
61
|
-
<a class="nav-link" href="/en/">Overview</a>
|
|
62
|
-
<a class="nav-link" href="/en/ecosystem">Ecosystem</a>
|
|
63
|
-
<a class="nav-link current" href="/en/quickstart" aria-current="page">
|
|
64
|
-
<a class="nav-link" href="/en/windows">Windows</a>
|
|
65
|
-
<a class="nav-link" href="/en/
|
|
66
|
-
<a class="nav-link" href="/en/
|
|
60
|
+
<a class="nav-link" href="/en/"><svg class="icon" viewBox="0 0 24 24" aria-hidden="true"><use href="#icon-home"/></svg><span>Overview</span></a>
|
|
61
|
+
<a class="nav-link" href="/en/ecosystem"><svg class="icon" viewBox="0 0 24 24" aria-hidden="true"><use href="#icon-network"/></svg><span>Ecosystem</span></a>
|
|
62
|
+
<a class="nav-link current" href="/en/quickstart" aria-current="page"><svg class="icon" viewBox="0 0 24 24" aria-hidden="true"><use href="#icon-rocket"/></svg><span>Install</span></a>
|
|
63
|
+
<a class="nav-link" href="/en/windows"><svg class="icon" viewBox="0 0 24 24" aria-hidden="true"><use href="#icon-windows"/></svg><span>Windows</span></a>
|
|
64
|
+
<a class="nav-link" href="/en/update"><svg class="icon" viewBox="0 0 24 24" aria-hidden="true"><use href="#icon-refresh"/></svg><span>Update & uninstall</span></a>
|
|
65
|
+
<a class="nav-link" href="/en/whats-new"><svg class="icon" viewBox="0 0 24 24" aria-hidden="true"><use href="#icon-sparkles"/></svg><span>Changelog</span></a>
|
|
66
|
+
<a class="nav-link" href="/en/scope"><svg class="icon" viewBox="0 0 24 24" aria-hidden="true"><use href="#icon-target"/></svg><span>Platform scope</span></a>
|
|
67
67
|
</div>
|
|
68
68
|
<div class="nav-group">
|
|
69
69
|
<p class="nav-title">Build</p>
|
|
70
|
-
<a class="nav-link" href="/en/profiles">Project profiles</a>
|
|
71
|
-
<a class="nav-link" href="/en/permissions">Permission modes</a>
|
|
72
|
-
<a class="nav-link" href="/en/commands">Command catalog</a>
|
|
73
|
-
<a class="nav-link" href="/en/workflows">Workflows</a>
|
|
70
|
+
<a class="nav-link" href="/en/profiles"><svg class="icon" viewBox="0 0 24 24" aria-hidden="true"><use href="#icon-sliders"/></svg><span>Project profiles</span></a>
|
|
71
|
+
<a class="nav-link" href="/en/permissions"><svg class="icon" viewBox="0 0 24 24" aria-hidden="true"><use href="#icon-key"/></svg><span>Permission modes</span></a>
|
|
72
|
+
<a class="nav-link" href="/en/commands"><svg class="icon" viewBox="0 0 24 24" aria-hidden="true"><use href="#icon-terminal"/></svg><span>Command catalog</span></a>
|
|
73
|
+
<a class="nav-link" href="/en/workflows"><svg class="icon" viewBox="0 0 24 24" aria-hidden="true"><use href="#icon-branch"/></svg><span>Workflows</span></a>
|
|
74
74
|
</div>
|
|
75
75
|
<div class="nav-group">
|
|
76
76
|
<p class="nav-title">MCP</p>
|
|
77
|
-
<a class="nav-link" href="/en/mcp">MCP overview</a>
|
|
78
|
-
<a class="nav-link" href="/en/mcp-servers">Server management</a>
|
|
79
|
-
<a class="nav-link" href="/en/mcp-auth">Authentication</a>
|
|
80
|
-
<a class="nav-link" href="/en/mcp-approval">Approval gate</a>
|
|
77
|
+
<a class="nav-link" href="/en/mcp"><svg class="icon" viewBox="0 0 24 24" aria-hidden="true"><use href="#icon-plug"/></svg><span>MCP overview</span></a>
|
|
78
|
+
<a class="nav-link" href="/en/mcp-servers"><svg class="icon" viewBox="0 0 24 24" aria-hidden="true"><use href="#icon-server"/></svg><span>Server management</span></a>
|
|
79
|
+
<a class="nav-link" href="/en/mcp-auth"><svg class="icon" viewBox="0 0 24 24" aria-hidden="true"><use href="#icon-lock"/></svg><span>Authentication</span></a>
|
|
80
|
+
<a class="nav-link" href="/en/mcp-approval"><svg class="icon" viewBox="0 0 24 24" aria-hidden="true"><use href="#icon-shield-check"/></svg><span>Approval gate</span></a>
|
|
81
81
|
</div>
|
|
82
82
|
<div class="nav-group">
|
|
83
83
|
<p class="nav-title">Operate</p>
|
|
84
|
-
<a class="nav-link" href="/en/security">Security model</a>
|
|
85
|
-
<a class="nav-link" href="/en/architecture">Architecture</a>
|
|
86
|
-
<a class="nav-link" href="/en/context-engine">Context Engine</a>
|
|
87
|
-
<a class="nav-link" href="/en/benchmark">Benchmark</a>
|
|
88
|
-
<a class="nav-link" href="/en/runtime">Runtime tools</a>
|
|
89
|
-
<a class="nav-link" href="/en/team">Team usage</a>
|
|
84
|
+
<a class="nav-link" href="/en/security"><svg class="icon" viewBox="0 0 24 24" aria-hidden="true"><use href="#icon-shield"/></svg><span>Security model</span></a>
|
|
85
|
+
<a class="nav-link" href="/en/architecture"><svg class="icon" viewBox="0 0 24 24" aria-hidden="true"><use href="#icon-layers"/></svg><span>Architecture</span></a>
|
|
86
|
+
<a class="nav-link" href="/en/context-engine"><svg class="icon" viewBox="0 0 24 24" aria-hidden="true"><use href="#icon-cpu"/></svg><span>Context Engine</span></a>
|
|
87
|
+
<a class="nav-link" href="/en/benchmark"><svg class="icon" viewBox="0 0 24 24" aria-hidden="true"><use href="#icon-chart"/></svg><span>Benchmark</span></a>
|
|
88
|
+
<a class="nav-link" href="/en/runtime"><svg class="icon" viewBox="0 0 24 24" aria-hidden="true"><use href="#icon-wrench"/></svg><span>Runtime tools</span></a>
|
|
89
|
+
<a class="nav-link" href="/en/team"><svg class="icon" viewBox="0 0 24 24" aria-hidden="true"><use href="#icon-users"/></svg><span>Team usage</span></a>
|
|
90
90
|
</div>
|
|
91
91
|
</nav>
|
|
92
92
|
</aside>
|
|
93
93
|
|
|
94
|
-
<main>
|
|
94
|
+
<main id="content">
|
|
95
95
|
<div class="content-shell" data-article>
|
|
96
96
|
<nav class="breadcrumb" aria-label="Breadcrumb">
|
|
97
97
|
<a href="/en/">Docs</a>
|
|
98
98
|
<span aria-hidden="true">/</span>
|
|
99
99
|
<span>Get started</span>
|
|
100
|
-
<span aria-hidden="true">/</span>
|
|
101
|
-
<span>Quickstart</span>
|
|
102
100
|
</nav>
|
|
103
101
|
<div class="page-head">
|
|
104
|
-
<h1>
|
|
105
|
-
<p>
|
|
102
|
+
<h1>Install and run your first turn</h1>
|
|
103
|
+
<p>Two commands to install. Open a repository, pick its profile and permissions, then ask in plain language.</p>
|
|
104
|
+
<div class="page-meta">
|
|
105
|
+
<a href="https://github.com/Vt-mmm/piagent/blob/main/docs-site/content/en/quickstart.html" target="_blank" rel="noopener noreferrer"><svg class="icon" viewBox="0 0 24 24" aria-hidden="true"><use href="#icon-edit"/></svg>Edit this page</a>
|
|
106
|
+
</div>
|
|
106
107
|
</div>
|
|
107
108
|
<section class="section">
|
|
108
109
|
<div class="steps">
|
|
109
110
|
<article class="step">
|
|
110
|
-
<
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
<div class="
|
|
114
|
-
<
|
|
115
|
-
|
|
116
|
-
<tbody>
|
|
117
|
-
<tr><td>macOS Apple Silicon + Bash</td><td>Verified for this release.</td></tr>
|
|
118
|
-
<tr><td>Linux x64 + Bash</td><td>Verified in CI.</td></tr>
|
|
119
|
-
<tr><td>macOS Intel / Linux ARM64 + Bash</td><td>Supported target; run doctor and smoke tests before broad rollout.</td></tr>
|
|
120
|
-
<tr><td>Windows (WSL2)</td><td>One PowerShell command installs everything: see <a href="/en/windows">Windows</a>. Running on Windows itself is a preview of personal mode.</td></tr>
|
|
121
|
-
</tbody>
|
|
122
|
-
</table>
|
|
111
|
+
<h3 id="install">Install</h3>
|
|
112
|
+
<p>Requires Node.js 22.19.0 or later. You do not need Pi first: <code>piagent-setup</code> installs the exact Pi release this version pins, initializes <code>.pi/</code>, installs the MCP baseline and subagents, then runs the doctor.</p>
|
|
113
|
+
<div class="tabs" data-tabs="os">
|
|
114
|
+
<div class="tab-list" role="tablist" aria-label="Operating system">
|
|
115
|
+
<button type="button" role="tab" data-tab="macos" aria-selected="true"><svg class="icon" viewBox="0 0 24 24" aria-hidden="true"><use href="#icon-apple"/></svg> macOS · Linux</button>
|
|
116
|
+
<button type="button" role="tab" data-tab="windows" aria-selected="false" tabindex="-1"><svg class="icon" viewBox="0 0 24 24" aria-hidden="true"><use href="#icon-windows"/></svg> Windows</button>
|
|
123
117
|
</div>
|
|
124
|
-
<div class="
|
|
125
|
-
<
|
|
126
|
-
|
|
118
|
+
<div class="tab-panel" data-panel="macos">
|
|
119
|
+
<div class="command-card">
|
|
120
|
+
<header><span>Run in the project folder</span><button class="clip-btn" data-clip="npm install -g @piagent/platform piagent-setup">Copy</button></header>
|
|
121
|
+
<pre><code>npm install -g @piagent/platform
|
|
127
122
|
piagent-setup</code></pre>
|
|
123
|
+
</div>
|
|
128
124
|
</div>
|
|
129
|
-
<
|
|
130
|
-
|
|
131
|
-
|
|
132
|
-
|
|
133
|
-
|
|
134
|
-
|
|
135
|
-
</div>
|
|
136
|
-
<p>The <span class="inline-code">curl</span> form executes a downloaded installer. For an auditable path, use <span class="inline-code">brew</span> or download from <a href="https://github.com/ogulcancelik/herdr/releases">GitHub releases</a>. Herdr stable supports macOS and Linux; Windows remains preview.</p>
|
|
137
|
-
<p>See the <a href="https://github.com/Vt-mmm/piagent/blob/main/docs/release-install-policy.md">release and install policy</a> for pinned rollout, updates, rollback, and the latest channel for personal machines.</p>
|
|
138
|
-
</div>
|
|
139
|
-
</article>
|
|
140
|
-
|
|
141
|
-
<article class="step">
|
|
142
|
-
<div>
|
|
143
|
-
<h3 id="open-project-repository">Open the project repository</h3>
|
|
144
|
-
<p>Start Pi from the repository directory. In a trusted repository, use the trusted-run wrapper only when controlled automation is needed.</p>
|
|
145
|
-
<div class="command-card">
|
|
146
|
-
<header><span>Start</span><button class="clip-btn" data-clip="cd /path/to/project && pi">Copy</button></header>
|
|
147
|
-
<pre><code>cd /path/to/project
|
|
148
|
-
pi</code></pre>
|
|
125
|
+
<div class="tab-panel" data-panel="windows" hidden>
|
|
126
|
+
<div class="command-card">
|
|
127
|
+
<header><span>PowerShell</span><button class="clip-btn" data-clip="irm https://raw.githubusercontent.com/Vt-mmm/agentwatch/main/windows/setup.ps1 | iex">Copy</button></header>
|
|
128
|
+
<pre><code>irm https://raw.githubusercontent.com/Vt-mmm/agentwatch/main/windows/setup.ps1 | iex</code></pre>
|
|
129
|
+
</div>
|
|
130
|
+
<p>Installs WSL2, Ubuntu, Piagent and Agent Watch. Details in <a href="/en/windows">Windows</a>.</p>
|
|
149
131
|
</div>
|
|
150
|
-
<p>For multiple parallel agents, run <span class="inline-code">herdr</span> instead of <span class="inline-code">pi</span> and assign one role per pane: implementation, read-only review, verification, or notes. Herdr coordinates terminals and sessions; it is not a security boundary. Gates remain in the Pi extension and OAuth still occurs in Pi. See the <a href="https://github.com/Vt-mmm/piagent/blob/main/docs/herdr-workflow.md">Herdr workflow</a>.</p>
|
|
151
132
|
</div>
|
|
133
|
+
<p>Skip the extras with <code>--no-mcp</code>, <code>--no-subagents</code>, <code>--no-herdr</code> or <code>--global-only</code>.</p>
|
|
152
134
|
</article>
|
|
153
135
|
|
|
154
136
|
<article class="step">
|
|
155
|
-
<
|
|
156
|
-
|
|
157
|
-
|
|
158
|
-
<
|
|
159
|
-
|
|
160
|
-
|
|
161
|
-
|
|
137
|
+
<h3 id="open-project">Open a project</h3>
|
|
138
|
+
<p>Terminal and the dashboard share one history. Company mode opens with <code>piagent studio</code> once the key is imported through Agent Watch.</p>
|
|
139
|
+
<div class="command-card">
|
|
140
|
+
<header><span>Pick one</span><button class="clip-btn" data-clip="piagent dashboard">Copy</button></header>
|
|
141
|
+
<pre><code>piagent dashboard # browser, personal mode
|
|
142
|
+
pi # Terminal, personal mode
|
|
143
|
+
piagent studio --web # company mode</code></pre>
|
|
162
144
|
</div>
|
|
163
145
|
</article>
|
|
164
146
|
|
|
165
147
|
<article class="step">
|
|
166
|
-
<
|
|
167
|
-
|
|
168
|
-
|
|
169
|
-
<
|
|
170
|
-
|
|
171
|
-
<pre><code>/profile setup
|
|
172
|
-
/profile tech setup fullstack</code></pre>
|
|
173
|
-
</div>
|
|
148
|
+
<h3 id="read-project">Let the agent read the project</h3>
|
|
149
|
+
<p>In a new repository, ask the agent to read it (read-only) and record the project context in <code>.pi/</code>. No special command is needed.</p>
|
|
150
|
+
<div class="command-card">
|
|
151
|
+
<header><span>First message</span><button class="clip-btn" data-clip="Read this project (read-only) and record the project context.">Copy</button></header>
|
|
152
|
+
<pre><code>Read this project (read-only) and record the project context.</code></pre>
|
|
174
153
|
</div>
|
|
175
154
|
</article>
|
|
176
155
|
|
|
177
156
|
<article class="step">
|
|
178
|
-
<
|
|
179
|
-
|
|
180
|
-
|
|
181
|
-
<
|
|
182
|
-
|
|
183
|
-
<pre><code>/permission status
|
|
157
|
+
<h3 id="profile-and-permission">Pick a profile and permission</h3>
|
|
158
|
+
<p>The profile decides which files are protected and which checks run. Permission: <code>read-only</code> to explore, <code>workspace-write</code> for normal coding.</p>
|
|
159
|
+
<div class="command-card">
|
|
160
|
+
<header><span>Slash commands</span><button class="clip-btn" data-clip="/profile setup /permission workspace-write">Copy</button></header>
|
|
161
|
+
<pre><code>/profile setup
|
|
184
162
|
/permission workspace-write</code></pre>
|
|
185
|
-
</div>
|
|
186
163
|
</div>
|
|
187
164
|
</article>
|
|
188
165
|
|
|
189
166
|
<article class="step">
|
|
190
|
-
<
|
|
191
|
-
|
|
192
|
-
|
|
193
|
-
<
|
|
194
|
-
|
|
195
|
-
<pre><code>Implement the requested change and run the project tests.
|
|
167
|
+
<h3 id="ask">Ask in plain language</h3>
|
|
168
|
+
<p>Say what you need and how: edit, read-only, or plan first. For context-heavy work, start a fresh session with <code>/new</code>.</p>
|
|
169
|
+
<div class="command-card">
|
|
170
|
+
<header><span>Examples</span><button class="clip-btn" data-clip="Fix the pagination bug in /orders, then run the project's tests.">Copy</button></header>
|
|
171
|
+
<pre><code>Fix the pagination bug in /orders, then run the project's tests.
|
|
196
172
|
Review the current diff. Read-only.</code></pre>
|
|
197
|
-
</div>
|
|
198
173
|
</div>
|
|
199
174
|
</article>
|
|
200
175
|
|
|
201
176
|
<article class="step">
|
|
202
|
-
<
|
|
203
|
-
|
|
204
|
-
|
|
205
|
-
<
|
|
206
|
-
|
|
207
|
-
<pre><code>piagent-doctor</code></pre>
|
|
208
|
-
</div>
|
|
209
|
-
<p>Platform maintainers also run <span class="inline-code">npm run verify</span> in the source repository. See <a href="https://github.com/Vt-mmm/piagent/blob/main/CONTRIBUTING.md">CONTRIBUTING</a>.</p>
|
|
177
|
+
<h3 id="check">Check the installation</h3>
|
|
178
|
+
<p>After installing or changing releases, run the doctor on the project. Every finding comes with the fix.</p>
|
|
179
|
+
<div class="command-card">
|
|
180
|
+
<header><span>Doctor</span><button class="clip-btn" data-clip="piagent-doctor">Copy</button></header>
|
|
181
|
+
<pre><code>piagent-doctor</code></pre>
|
|
210
182
|
</div>
|
|
211
183
|
</article>
|
|
184
|
+
</div>
|
|
185
|
+
</section>
|
|
212
186
|
|
|
213
|
-
|
|
214
|
-
|
|
215
|
-
|
|
216
|
-
|
|
217
|
-
|
|
218
|
-
|
|
219
|
-
|
|
220
|
-
|
|
221
|
-
</
|
|
222
|
-
<
|
|
223
|
-
<
|
|
224
|
-
|
|
225
|
-
|
|
226
|
-
|
|
227
|
-
|
|
228
|
-
|
|
187
|
+
<section class="section">
|
|
188
|
+
<h2 id="supported">Supported systems</h2>
|
|
189
|
+
<div class="table-wrap">
|
|
190
|
+
<table>
|
|
191
|
+
<thead><tr><th>Environment</th><th>Status</th></tr></thead>
|
|
192
|
+
<tbody>
|
|
193
|
+
<tr><td>macOS Apple Silicon</td><td>Verified for this release.</td></tr>
|
|
194
|
+
<tr><td>Linux x64</td><td>Verified in CI.</td></tr>
|
|
195
|
+
<tr><td>macOS Intel, Linux ARM64</td><td>Supported; run the doctor and smoke tests before a wide rollout.</td></tr>
|
|
196
|
+
<tr><td>Windows (WSL2)</td><td>The way to run Piagent on Windows, in both personal and company mode.</td></tr>
|
|
197
|
+
<tr><td>Native Windows</td><td>Preview of personal mode; <code>piagent-update</code> is not available yet.</td></tr>
|
|
198
|
+
</tbody>
|
|
199
|
+
</table>
|
|
200
|
+
</div>
|
|
201
|
+
<div class="callout">
|
|
202
|
+
<strong>Using Herdr?</strong>
|
|
203
|
+
<p>Install Herdr <em>before</em> <code>piagent-setup</code> to get its Pi integration; if you install it later, run <code>piagent-setup --global-only</code> again. Herdr arranges terminals; it is not a protection layer. See the <a href="https://github.com/Vt-mmm/piagent/blob/main/docs/herdr-workflow.md">Herdr workflow</a>.</p>
|
|
204
|
+
</div>
|
|
205
|
+
</section>
|
|
206
|
+
|
|
207
|
+
<section class="section">
|
|
208
|
+
<h2 id="next">Next</h2>
|
|
209
|
+
<div class="card-grid">
|
|
210
|
+
<a class="doc-card" href="/en/update"><span class="card-kicker"><svg class="icon" viewBox="0 0 24 24" aria-hidden="true"><use href="#icon-refresh"/></svg> Operate</span><h3>Update & uninstall</h3><p>New releases, team pins, rollback, and an uninstall that previews first.</p></a>
|
|
211
|
+
<a class="doc-card" href="/en/ecosystem"><span class="card-kicker"><svg class="icon" viewBox="0 0 24 24" aria-hidden="true"><use href="#icon-network"/></svg> Get started</span><h3>Ecosystem</h3><p>When to use your own model and when to use Agent Studio.</p></a>
|
|
212
|
+
<a class="doc-card" href="/en/permissions"><span class="card-kicker"><svg class="icon" viewBox="0 0 24 24" aria-hidden="true"><use href="#icon-key"/></svg> Build</span><h3>Permission modes</h3><p>The four permission levels and when to use each.</p></a>
|
|
213
|
+
<a class="doc-card" href="/en/mcp"><span class="card-kicker"><svg class="icon" viewBox="0 0 24 24" aria-hidden="true"><use href="#icon-plug"/></svg> MCP</span><h3>MCP</h3><p>Pinned presets, server management and the approval gate.</p></a>
|
|
229
214
|
</div>
|
|
230
215
|
</section>
|
|
231
216
|
<nav class="pager" aria-label="Adjacent pages">
|
|
232
217
|
<a class="pager-prev" href="/en/ecosystem">
|
|
233
|
-
<span class="pager-label"
|
|
218
|
+
<span class="pager-label">← Previous</span>
|
|
234
219
|
<span class="pager-title">Ecosystem</span>
|
|
235
220
|
</a>
|
|
236
221
|
<a class="pager-next" href="/en/windows">
|
|
237
|
-
<span class="pager-label">Next
|
|
222
|
+
<span class="pager-label">Next →</span>
|
|
238
223
|
<span class="pager-title">Windows</span>
|
|
239
224
|
</a>
|
|
240
225
|
</nav>
|
|
241
226
|
|
|
242
227
|
<footer class="footer">
|
|
243
|
-
<p>Pi Agent Platform
|
|
228
|
+
<p>Pi Agent Platform · MIT · static docs, no cookies</p>
|
|
244
229
|
<div class="footer-links" aria-label="External links">
|
|
245
|
-
<a href="https://piagent
|
|
246
|
-
<a href="https://
|
|
230
|
+
<a href="https://github.com/Vt-mmm/piagent" target="_blank" rel="noopener noreferrer">GitHub</a>
|
|
231
|
+
<a href="https://www.npmjs.com/package/@piagent/platform" target="_blank" rel="noopener noreferrer">npm</a>
|
|
247
232
|
<a href="/quickstart" hreflang="vi">Tiếng Việt</a>
|
|
248
|
-
<a href="https://www.facebook.com/vinhtam0544/" target="_blank" rel="noopener noreferrer">Facebook
|
|
233
|
+
<a href="https://www.facebook.com/vinhtam0544/" target="_blank" rel="noopener noreferrer">Facebook</a>
|
|
249
234
|
</div>
|
|
250
235
|
</footer>
|
|
251
236
|
</div>
|
|
@@ -256,6 +241,13 @@ piagent-uninstall --apply</code></pre>
|
|
|
256
241
|
<nav data-toc></nav>
|
|
257
242
|
</aside>
|
|
258
243
|
</div>
|
|
244
|
+
<div class="palette" data-palette data-index="/assets/search-en.json" data-empty="No page matches." role="dialog" aria-modal="true" aria-label="Search documentation">
|
|
245
|
+
<div class="palette-box">
|
|
246
|
+
<label class="palette-input"><svg class="icon" viewBox="0 0 24 24" aria-hidden="true"><use href="#icon-search"/></svg><input type="search" placeholder="Search the docs…" aria-label="Search documentation" autocomplete="off" spellcheck="false" /></label>
|
|
247
|
+
<div class="palette-results" data-results role="listbox"></div>
|
|
248
|
+
<div class="palette-foot"><span>↑↓ select</span><span>↵ open</span><span>esc close</span></div>
|
|
249
|
+
</div>
|
|
250
|
+
</div>
|
|
259
251
|
<script>
|
|
260
252
|
window.va = window.va || function () { (window.vaq = window.vaq || []).push(arguments); };
|
|
261
253
|
</script>
|