@plotday/twister 0.20.0
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/LICENSE +21 -0
- package/README.md +261 -0
- package/bin/commands/build.js +108 -0
- package/bin/commands/build.js.map +1 -0
- package/bin/commands/create.js +230 -0
- package/bin/commands/create.js.map +1 -0
- package/bin/commands/deploy.js +292 -0
- package/bin/commands/deploy.js.map +1 -0
- package/bin/commands/generate.js +301 -0
- package/bin/commands/generate.js.map +1 -0
- package/bin/commands/lint.js +69 -0
- package/bin/commands/lint.js.map +1 -0
- package/bin/commands/login.js +140 -0
- package/bin/commands/login.js.map +1 -0
- package/bin/commands/priority-create.js +102 -0
- package/bin/commands/priority-create.js.map +1 -0
- package/bin/commands/priority-list.js +47 -0
- package/bin/commands/priority-list.js.map +1 -0
- package/bin/commands/twist-logs.js +187 -0
- package/bin/commands/twist-logs.js.map +1 -0
- package/bin/index.js +129 -0
- package/bin/index.js.map +1 -0
- package/bin/package.json +3 -0
- package/bin/plot.cjs +3 -0
- package/bin/templates/AGENTS.template.md +403 -0
- package/bin/templates/CLAUDE.template.md +1 -0
- package/bin/templates/README.template.md +189 -0
- package/bin/utils/bundle.js +106 -0
- package/bin/utils/bundle.js.map +1 -0
- package/bin/utils/output.js +133 -0
- package/bin/utils/output.js.map +1 -0
- package/bin/utils/packageManager.js +65 -0
- package/bin/utils/packageManager.js.map +1 -0
- package/bin/utils/sse.js +100 -0
- package/bin/utils/sse.js.map +1 -0
- package/bin/utils/token.js +75 -0
- package/bin/utils/token.js.map +1 -0
- package/cli/templates/AGENTS.template.md +403 -0
- package/cli/templates/CLAUDE.template.md +1 -0
- package/cli/templates/README.template.md +189 -0
- package/dist/common/calendar.d.ts +144 -0
- package/dist/common/calendar.d.ts.map +1 -0
- package/dist/common/calendar.js +2 -0
- package/dist/common/calendar.js.map +1 -0
- package/dist/common/messaging.d.ts +84 -0
- package/dist/common/messaging.d.ts.map +1 -0
- package/dist/common/messaging.js +2 -0
- package/dist/common/messaging.js.map +1 -0
- package/dist/creator-docs.d.ts +11 -0
- package/dist/creator-docs.d.ts.map +1 -0
- package/dist/creator-docs.js +27 -0
- package/dist/creator-docs.js.map +1 -0
- package/dist/docs/.nojekyll +1 -0
- package/dist/docs/assets/favicon.svg +8 -0
- package/dist/docs/assets/hierarchy.js +1 -0
- package/dist/docs/assets/highlight.css +134 -0
- package/dist/docs/assets/icons.js +18 -0
- package/dist/docs/assets/icons.svg +1 -0
- package/dist/docs/assets/main.js +60 -0
- package/dist/docs/assets/navigation.js +1 -0
- package/dist/docs/assets/search.js +1 -0
- package/dist/docs/assets/style.css +1633 -0
- package/dist/docs/classes/tool.ITool.html +4 -0
- package/dist/docs/classes/tool.Tool.html +116 -0
- package/dist/docs/classes/tools_ai.AI.html +27 -0
- package/dist/docs/classes/tools_callbacks.Callbacks.html +45 -0
- package/dist/docs/classes/tools_integrations.Integrations.html +26 -0
- package/dist/docs/classes/tools_network.Network.html +68 -0
- package/dist/docs/classes/tools_plot.Plot.html +82 -0
- package/dist/docs/classes/tools_store.Store.html +53 -0
- package/dist/docs/classes/tools_tasks.Tasks.html +39 -0
- package/dist/docs/classes/tools_twists.Twists.html +59 -0
- package/dist/docs/classes/twist.Twist.html +96 -0
- package/dist/docs/documents/Advanced.html +91 -0
- package/dist/docs/documents/Building_Custom_Tools.html +200 -0
- package/dist/docs/documents/Built-in_Tools.html +170 -0
- package/dist/docs/documents/CLI_Reference.html +193 -0
- package/dist/docs/documents/Core_Concepts.html +163 -0
- package/dist/docs/documents/Getting_Started.html +94 -0
- package/dist/docs/documents/Runtime_Environment.html +128 -0
- package/dist/docs/enums/plot.ActivityLinkType.html +12 -0
- package/dist/docs/enums/plot.ActivityType.html +10 -0
- package/dist/docs/enums/plot.ActorType.html +10 -0
- package/dist/docs/enums/plot.ConferencingProvider.html +14 -0
- package/dist/docs/enums/tag.Tag.html +45 -0
- package/dist/docs/enums/tools_ai.AIModel.html +31 -0
- package/dist/docs/enums/tools_integrations.AuthLevel.html +7 -0
- package/dist/docs/enums/tools_integrations.AuthProvider.html +24 -0
- package/dist/docs/enums/tools_plot.ActivityAccess.html +8 -0
- package/dist/docs/enums/tools_plot.ContactAccess.html +5 -0
- package/dist/docs/enums/tools_plot.PriorityAccess.html +8 -0
- package/dist/docs/hierarchy.html +1 -0
- package/dist/docs/index.html +100 -0
- package/dist/docs/interfaces/common_calendar.Calendar.html +13 -0
- package/dist/docs/interfaces/common_calendar.CalendarTool.html +49 -0
- package/dist/docs/interfaces/common_calendar.SyncOptions.html +8 -0
- package/dist/docs/interfaces/tools_ai.AIRequest.html +46 -0
- package/dist/docs/interfaces/tools_ai.AIResponse.html +19 -0
- package/dist/docs/interfaces/tools_ai.FilePart.html +14 -0
- package/dist/docs/interfaces/tools_ai.ImagePart.html +11 -0
- package/dist/docs/interfaces/tools_ai.ReasoningPart.html +7 -0
- package/dist/docs/interfaces/tools_ai.RedactedReasoningPart.html +5 -0
- package/dist/docs/interfaces/tools_ai.TextPart.html +5 -0
- package/dist/docs/interfaces/tools_ai.ToolCallPart.html +9 -0
- package/dist/docs/interfaces/tools_ai.ToolExecutionOptions.html +9 -0
- package/dist/docs/interfaces/tools_ai.ToolResultPart.html +9 -0
- package/dist/docs/interfaces/tools_twists.TwistSource.html +13 -0
- package/dist/docs/interfaces/utils_types.ToolShed.html +11 -0
- package/dist/docs/modules/common_calendar.html +1 -0
- package/dist/docs/modules/index.html +1 -0
- package/dist/docs/modules/plot.html +1 -0
- package/dist/docs/modules/tag.html +1 -0
- package/dist/docs/modules/tool.html +1 -0
- package/dist/docs/modules/tools_ai.html +1 -0
- package/dist/docs/modules/tools_callbacks.html +1 -0
- package/dist/docs/modules/tools_integrations.html +1 -0
- package/dist/docs/modules/tools_network.html +1 -0
- package/dist/docs/modules/tools_plot.html +1 -0
- package/dist/docs/modules/tools_store.html +1 -0
- package/dist/docs/modules/tools_tasks.html +1 -0
- package/dist/docs/modules/tools_twists.html +1 -0
- package/dist/docs/modules/twist.html +1 -0
- package/dist/docs/modules/utils_types.html +1 -0
- package/dist/docs/modules.html +1 -0
- package/dist/docs/types/common_calendar.CalendarAuth.html +7 -0
- package/dist/docs/types/plot.Activity.html +64 -0
- package/dist/docs/types/plot.ActivityLink.html +22 -0
- package/dist/docs/types/plot.ActivityMeta.html +11 -0
- package/dist/docs/types/plot.ActivityUpdate.html +13 -0
- package/dist/docs/types/plot.Actor.html +15 -0
- package/dist/docs/types/plot.ActorId.html +4 -0
- package/dist/docs/types/plot.NewActivity.html +16 -0
- package/dist/docs/types/plot.NewContact.html +13 -0
- package/dist/docs/types/plot.NewPriority.html +5 -0
- package/dist/docs/types/plot.NoteType.html +1 -0
- package/dist/docs/types/plot.PickPriorityConfig.html +22 -0
- package/dist/docs/types/plot.Priority.html +8 -0
- package/dist/docs/types/tools_ai.AIAssistantMessage.html +4 -0
- package/dist/docs/types/tools_ai.AIMessage.html +3 -0
- package/dist/docs/types/tools_ai.AISource.html +11 -0
- package/dist/docs/types/tools_ai.AISystemMessage.html +7 -0
- package/dist/docs/types/tools_ai.AITool.html +19 -0
- package/dist/docs/types/tools_ai.AIToolMessage.html +4 -0
- package/dist/docs/types/tools_ai.AIToolSet.html +1 -0
- package/dist/docs/types/tools_ai.AIUsage.html +10 -0
- package/dist/docs/types/tools_ai.AIUserMessage.html +4 -0
- package/dist/docs/types/tools_ai.DataContent.html +2 -0
- package/dist/docs/types/tools_ai.ModelPreferences.html +24 -0
- package/dist/docs/types/tools_callbacks.Callback.html +8 -0
- package/dist/docs/types/tools_integrations.AuthToken.html +16 -0
- package/dist/docs/types/tools_integrations.Authorization.html +10 -0
- package/dist/docs/types/tools_network.WebhookRequest.html +15 -0
- package/dist/docs/types/tools_plot.ActivityIntentHandler.html +9 -0
- package/dist/docs/types/tools_twists.Log.html +6 -0
- package/dist/docs/types/tools_twists.TwistPermissions.html +12 -0
- package/dist/docs/types/utils_types.BuiltInTools.html +5 -0
- package/dist/docs/types/utils_types.CallbackMethods.html +3 -0
- package/dist/docs/types/utils_types.ExtractBuildReturn.html +2 -0
- package/dist/docs/types/utils_types.InferOptions.html +2 -0
- package/dist/docs/types/utils_types.InferTools.html +3 -0
- package/dist/docs/types/utils_types.NoFunctions.html +3 -0
- package/dist/docs/types/utils_types.NonFunction.html +2 -0
- package/dist/docs/types/utils_types.PromiseValues.html +3 -0
- package/dist/docs/types/utils_types.ToolBuilder.html +3 -0
- package/dist/index.d.ts +7 -0
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +7 -0
- package/dist/index.js.map +1 -0
- package/dist/llm-docs/common/calendar.d.ts +9 -0
- package/dist/llm-docs/common/calendar.d.ts.map +1 -0
- package/dist/llm-docs/common/calendar.js +8 -0
- package/dist/llm-docs/common/calendar.js.map +1 -0
- package/dist/llm-docs/common/messaging.d.ts +9 -0
- package/dist/llm-docs/common/messaging.d.ts.map +1 -0
- package/dist/llm-docs/common/messaging.js +8 -0
- package/dist/llm-docs/common/messaging.js.map +1 -0
- package/dist/llm-docs/creator-docs.d.ts +9 -0
- package/dist/llm-docs/creator-docs.d.ts.map +1 -0
- package/dist/llm-docs/creator-docs.js +8 -0
- package/dist/llm-docs/creator-docs.js.map +1 -0
- package/dist/llm-docs/index.d.ts +11 -0
- package/dist/llm-docs/index.d.ts.map +1 -0
- package/dist/llm-docs/index.js +42 -0
- package/dist/llm-docs/index.js.map +1 -0
- package/dist/llm-docs/plot.d.ts +9 -0
- package/dist/llm-docs/plot.d.ts.map +1 -0
- package/dist/llm-docs/plot.js +8 -0
- package/dist/llm-docs/plot.js.map +1 -0
- package/dist/llm-docs/tag.d.ts +9 -0
- package/dist/llm-docs/tag.d.ts.map +1 -0
- package/dist/llm-docs/tag.js +8 -0
- package/dist/llm-docs/tag.js.map +1 -0
- package/dist/llm-docs/tool.d.ts +9 -0
- package/dist/llm-docs/tool.d.ts.map +1 -0
- package/dist/llm-docs/tool.js +8 -0
- package/dist/llm-docs/tool.js.map +1 -0
- package/dist/llm-docs/tools/ai.d.ts +9 -0
- package/dist/llm-docs/tools/ai.d.ts.map +1 -0
- package/dist/llm-docs/tools/ai.js +8 -0
- package/dist/llm-docs/tools/ai.js.map +1 -0
- package/dist/llm-docs/tools/callbacks.d.ts +9 -0
- package/dist/llm-docs/tools/callbacks.d.ts.map +1 -0
- package/dist/llm-docs/tools/callbacks.js +8 -0
- package/dist/llm-docs/tools/callbacks.js.map +1 -0
- package/dist/llm-docs/tools/integrations.d.ts +9 -0
- package/dist/llm-docs/tools/integrations.d.ts.map +1 -0
- package/dist/llm-docs/tools/integrations.js +8 -0
- package/dist/llm-docs/tools/integrations.js.map +1 -0
- package/dist/llm-docs/tools/network.d.ts +9 -0
- package/dist/llm-docs/tools/network.d.ts.map +1 -0
- package/dist/llm-docs/tools/network.js +8 -0
- package/dist/llm-docs/tools/network.js.map +1 -0
- package/dist/llm-docs/tools/plot.d.ts +9 -0
- package/dist/llm-docs/tools/plot.d.ts.map +1 -0
- package/dist/llm-docs/tools/plot.js +8 -0
- package/dist/llm-docs/tools/plot.js.map +1 -0
- package/dist/llm-docs/tools/store.d.ts +9 -0
- package/dist/llm-docs/tools/store.d.ts.map +1 -0
- package/dist/llm-docs/tools/store.js +8 -0
- package/dist/llm-docs/tools/store.js.map +1 -0
- package/dist/llm-docs/tools/tasks.d.ts +9 -0
- package/dist/llm-docs/tools/tasks.d.ts.map +1 -0
- package/dist/llm-docs/tools/tasks.js +8 -0
- package/dist/llm-docs/tools/tasks.js.map +1 -0
- package/dist/llm-docs/tools/twists.d.ts +9 -0
- package/dist/llm-docs/tools/twists.d.ts.map +1 -0
- package/dist/llm-docs/tools/twists.js +8 -0
- package/dist/llm-docs/tools/twists.js.map +1 -0
- package/dist/llm-docs/twist-guide-template.d.ts +9 -0
- package/dist/llm-docs/twist-guide-template.d.ts.map +1 -0
- package/dist/llm-docs/twist-guide-template.js +8 -0
- package/dist/llm-docs/twist-guide-template.js.map +1 -0
- package/dist/llm-docs/twist.d.ts +9 -0
- package/dist/llm-docs/twist.d.ts.map +1 -0
- package/dist/llm-docs/twist.js +8 -0
- package/dist/llm-docs/twist.js.map +1 -0
- package/dist/plot.d.ts +463 -0
- package/dist/plot.d.ts.map +1 -0
- package/dist/plot.js +68 -0
- package/dist/plot.js.map +1 -0
- package/dist/tag.d.ts +47 -0
- package/dist/tag.d.ts.map +1 -0
- package/dist/tag.js +51 -0
- package/dist/tag.js.map +1 -0
- package/dist/tool.d.ts +242 -0
- package/dist/tool.d.ts.map +1 -0
- package/dist/tool.js +283 -0
- package/dist/tool.js.map +1 -0
- package/dist/tools/ai.d.ts +697 -0
- package/dist/tools/ai.d.ts.map +1 -0
- package/dist/tools/ai.js +104 -0
- package/dist/tools/ai.js.map +1 -0
- package/dist/tools/callbacks.d.ts +96 -0
- package/dist/tools/callbacks.d.ts.map +1 -0
- package/dist/tools/callbacks.js +40 -0
- package/dist/tools/callbacks.js.map +1 -0
- package/dist/tools/index.d.ts +9 -0
- package/dist/tools/index.d.ts.map +1 -0
- package/dist/tools/index.js +9 -0
- package/dist/tools/index.js.map +1 -0
- package/dist/tools/integrations.d.ts +142 -0
- package/dist/tools/integrations.d.ts.map +1 -0
- package/dist/tools/integrations.js +79 -0
- package/dist/tools/integrations.js.map +1 -0
- package/dist/tools/network.d.ts +188 -0
- package/dist/tools/network.d.ts.map +1 -0
- package/dist/tools/network.js +87 -0
- package/dist/tools/network.js.map +1 -0
- package/dist/tools/plot.d.ts +252 -0
- package/dist/tools/plot.d.ts.map +1 -0
- package/dist/tools/plot.js +72 -0
- package/dist/tools/plot.js.map +1 -0
- package/dist/tools/store.d.ts +90 -0
- package/dist/tools/store.d.ts.map +1 -0
- package/dist/tools/store.js +48 -0
- package/dist/tools/store.js.map +1 -0
- package/dist/tools/tasks.d.ts +93 -0
- package/dist/tools/tasks.d.ts.map +1 -0
- package/dist/tools/tasks.js +58 -0
- package/dist/tools/tasks.js.map +1 -0
- package/dist/tools/twists.d.ts +213 -0
- package/dist/tools/twists.d.ts.map +1 -0
- package/dist/tools/twists.js +26 -0
- package/dist/tools/twists.js.map +1 -0
- package/dist/twist-guide.d.ts +2 -0
- package/dist/twist-guide.d.ts.map +1 -0
- package/dist/twist-guide.js +9 -0
- package/dist/twist-guide.js.map +1 -0
- package/dist/twist.d.ts +204 -0
- package/dist/twist.d.ts.map +1 -0
- package/dist/twist.js +216 -0
- package/dist/twist.js.map +1 -0
- package/dist/utils/types.d.ts +91 -0
- package/dist/utils/types.d.ts.map +1 -0
- package/dist/utils/types.js +2 -0
- package/dist/utils/types.js.map +1 -0
- package/package.json +206 -0
- package/tsconfig.base.json +28 -0
|
@@ -0,0 +1,193 @@
|
|
|
1
|
+
<!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>CLI Reference | Creating Plot Twists</title><link rel="icon" href="../assets/favicon.svg" type="image/svg+xml"/><meta name="description" content="Documentation for Creating Plot Twists"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><a href="/" class="title">Creating Plot Twists</a><div id="tsd-toolbar-links"><a href="https://plot.day">Plot</a><a href="https://github.com/plotday/plot">GitHub</a><a href="https://www.npmjs.com/package/@plotday/twister">NPM</a></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb" aria-label="Breadcrumb"><li><a href="" aria-current="page">CLI Reference</a></li></ul></div><div class="tsd-panel tsd-typography"><h1 id="cli-reference" class="tsd-anchor-link">CLI Reference<a href="#cli-reference" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h1><p>Complete reference for the Plot CLI (<code>plot</code> command).</p>
|
|
2
|
+
<h2 id="table-of-contents" class="tsd-anchor-link">Table of Contents<a href="#table-of-contents" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2><ul>
|
|
3
|
+
<li><a href="#installation">Installation</a></li>
|
|
4
|
+
<li><a href="#authentication">Authentication</a></li>
|
|
5
|
+
<li><a href="#twist-commands">twist Commands</a></li>
|
|
6
|
+
<li><a href="#priority-commands">Priority Commands</a></li>
|
|
7
|
+
<li><a href="#global-options">Global Options</a></li>
|
|
8
|
+
</ul>
|
|
9
|
+
<hr>
|
|
10
|
+
<h2 id="installation" class="tsd-anchor-link">Installation<a href="#installation" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2><p>The Plot CLI is included with the Builder:</p>
|
|
11
|
+
<pre><code class="bash"><span class="hl-7"># Run directly with npx</span><br/><span class="hl-6">npx</span><span class="hl-1"> </span><span class="hl-3">@plotday/twister</span><span class="hl-1"> [command]</span><br/><br/><span class="hl-7"># Or install globally</span><br/><span class="hl-6">npm</span><span class="hl-1"> </span><span class="hl-3">install</span><span class="hl-1"> </span><span class="hl-4">-g</span><span class="hl-1"> </span><span class="hl-3">@plotday/twister</span><br/><span class="hl-6">plot</span><span class="hl-1"> [command]</span>
|
|
12
|
+
</code><button type="button">Copy</button></pre>
|
|
13
|
+
|
|
14
|
+
<hr>
|
|
15
|
+
<h2 id="authentication" class="tsd-anchor-link">Authentication<a href="#authentication" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2><h3 id="plot-login" class="tsd-anchor-link">plot login<a href="#plot-login" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><p>Authenticate with Plot to generate an API token.</p>
|
|
16
|
+
<pre><code class="bash"><span class="hl-6">plot</span><span class="hl-1"> </span><span class="hl-3">login</span>
|
|
17
|
+
</code><button type="button">Copy</button></pre>
|
|
18
|
+
|
|
19
|
+
<p>This will:</p>
|
|
20
|
+
<ol>
|
|
21
|
+
<li>Open your browser to the Plot authentication page</li>
|
|
22
|
+
<li>After authentication, save your API token locally</li>
|
|
23
|
+
<li>Enable deploying and managing twists</li>
|
|
24
|
+
</ol>
|
|
25
|
+
<p><strong>Token Storage</strong>: The token is stored in <code>~/.plot/config.json</code></p>
|
|
26
|
+
<hr>
|
|
27
|
+
<h2 id="twist-commands" class="tsd-anchor-link">twist Commands<a href="#twist-commands" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2><h3 id="plot-create" class="tsd-anchor-link">plot create<a href="#plot-create" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><p>Scaffold a new twist project with TypeScript.</p>
|
|
28
|
+
<pre><code class="bash"><span class="hl-6">plot</span><span class="hl-1"> </span><span class="hl-3">create</span><span class="hl-1"> [options]</span>
|
|
29
|
+
</code><button type="button">Copy</button></pre>
|
|
30
|
+
|
|
31
|
+
<p><strong>Options:</strong></p>
|
|
32
|
+
<ul>
|
|
33
|
+
<li><code>--name <name></code> - Package name (kebab-case)</li>
|
|
34
|
+
<li><code>--display-name <name></code> - Human-readable display name</li>
|
|
35
|
+
<li><code>--dir <directory></code> - Output directory (default: current directory)</li>
|
|
36
|
+
</ul>
|
|
37
|
+
<p><strong>Example:</strong></p>
|
|
38
|
+
<pre><code class="bash"><span class="hl-6">plot</span><span class="hl-1"> </span><span class="hl-3">create</span><span class="hl-1"> </span><span class="hl-4">--name</span><span class="hl-1"> </span><span class="hl-3">my-calendar-twist</span><span class="hl-1"> </span><span class="hl-4">--display-name</span><span class="hl-1"> </span><span class="hl-3">"My Calendar twist"</span>
|
|
39
|
+
</code><button type="button">Copy</button></pre>
|
|
40
|
+
|
|
41
|
+
<p><strong>Creates:</strong></p>
|
|
42
|
+
<pre><code><span class="hl-2">my</span><span class="hl-1">-</span><span class="hl-2">calendar</span><span class="hl-1">-</span><span class="hl-2">twist</span><span class="hl-1">/</span><br/><span class="hl-1">├── </span><span class="hl-2">src</span><span class="hl-1">/</span><br/><span class="hl-1">│ └── </span><span class="hl-2">index</span><span class="hl-1">.</span><span class="hl-2">ts</span><br/><span class="hl-1">├── </span><span class="hl-2">package</span><span class="hl-1">.</span><span class="hl-2">json</span><br/><span class="hl-1">├── </span><span class="hl-2">tsconfig</span><span class="hl-1">.</span><span class="hl-2">json</span><br/><span class="hl-1">└── </span><span class="hl-2">plot</span><span class="hl-1">-</span><span class="hl-2">twist</span><span class="hl-1">.</span><span class="hl-2">json</span>
|
|
43
|
+
</code><button>Copy</button></pre>
|
|
44
|
+
|
|
45
|
+
<hr>
|
|
46
|
+
<h3 id="plot-generate" class="tsd-anchor-link">plot generate<a href="#plot-generate" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><p>Generate TypeScript code from a natural language <code>plot-twist.md</code> specification.</p>
|
|
47
|
+
<pre><code class="bash"><span class="hl-6">plot</span><span class="hl-1"> </span><span class="hl-3">generate</span><span class="hl-1"> [options]</span>
|
|
48
|
+
</code><button type="button">Copy</button></pre>
|
|
49
|
+
|
|
50
|
+
<p><strong>Options:</strong></p>
|
|
51
|
+
<ul>
|
|
52
|
+
<li><code>--input <path></code> - Path to <a href="http://plot-twist.md">plot-twist.md</a> (default: <code>./plot-twist.md</code>)</li>
|
|
53
|
+
<li><code>--output <directory></code> - Output directory (default: <code>./src</code>)</li>
|
|
54
|
+
<li><code>--overwrite</code> - Overwrite existing files</li>
|
|
55
|
+
</ul>
|
|
56
|
+
<p><strong>Example:</strong></p>
|
|
57
|
+
<pre><code class="bash"><span class="hl-6">plot</span><span class="hl-1"> </span><span class="hl-3">generate</span><span class="hl-1"> </span><span class="hl-4">--input</span><span class="hl-1"> </span><span class="hl-3">./my-spec.md</span><span class="hl-1"> </span><span class="hl-4">--output</span><span class="hl-1"> </span><span class="hl-3">./src</span>
|
|
58
|
+
</code><button type="button">Copy</button></pre>
|
|
59
|
+
|
|
60
|
+
<hr>
|
|
61
|
+
<h3 id="plot-lint" class="tsd-anchor-link">plot lint<a href="#plot-lint" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><p>Check twist code for errors without deploying.</p>
|
|
62
|
+
<pre><code class="bash"><span class="hl-6">plot</span><span class="hl-1"> </span><span class="hl-3">lint</span><span class="hl-1"> [options]</span>
|
|
63
|
+
</code><button type="button">Copy</button></pre>
|
|
64
|
+
|
|
65
|
+
<p><strong>Options:</strong></p>
|
|
66
|
+
<ul>
|
|
67
|
+
<li><code>--dir <directory></code> - twist directory (default: current directory)</li>
|
|
68
|
+
</ul>
|
|
69
|
+
<p><strong>Example:</strong></p>
|
|
70
|
+
<pre><code class="bash"><span class="hl-6">plot</span><span class="hl-1"> </span><span class="hl-3">lint</span><span class="hl-1"> </span><span class="hl-4">--dir</span><span class="hl-1"> </span><span class="hl-3">./my-twist</span>
|
|
71
|
+
</code><button type="button">Copy</button></pre>
|
|
72
|
+
|
|
73
|
+
<hr>
|
|
74
|
+
<h3 id="plot-deploy" class="tsd-anchor-link">plot deploy<a href="#plot-deploy" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><p>Deploy an twist to Plot.</p>
|
|
75
|
+
<pre><code class="bash"><span class="hl-6">plot</span><span class="hl-1"> </span><span class="hl-3">deploy</span><span class="hl-1"> [options]</span>
|
|
76
|
+
</code><button type="button">Copy</button></pre>
|
|
77
|
+
|
|
78
|
+
<p><strong>Options:</strong></p>
|
|
79
|
+
<ul>
|
|
80
|
+
<li><code>--twist-id <id></code> - Update existing twist (creates new if not specified)</li>
|
|
81
|
+
<li><code>--name <name></code> - twist name</li>
|
|
82
|
+
<li><code>--description <description></code> - twist description</li>
|
|
83
|
+
<li><code>--source <path></code> - Source directory (default: <code>./src</code>)</li>
|
|
84
|
+
<li><code>--env <environment></code> - Environment (default: <code>production</code>)</li>
|
|
85
|
+
<li><code>--dry-run</code> - Validate without deploying</li>
|
|
86
|
+
</ul>
|
|
87
|
+
<p><strong>Behavior:</strong></p>
|
|
88
|
+
<ul>
|
|
89
|
+
<li>If <code>plot-twist.md</code> exists: Generates code and deploys in one step</li>
|
|
90
|
+
<li>Otherwise: Deploys compiled TypeScript from <code>src/</code></li>
|
|
91
|
+
</ul>
|
|
92
|
+
<p><strong>Example:</strong></p>
|
|
93
|
+
<pre><code class="bash"><span class="hl-7"># Deploy new twist</span><br/><span class="hl-6">plot</span><span class="hl-1"> </span><span class="hl-3">deploy</span><br/><br/><span class="hl-7"># Update existing twist</span><br/><span class="hl-6">plot</span><span class="hl-1"> </span><span class="hl-3">deploy</span><span class="hl-1"> </span><span class="hl-4">--twist-id</span><span class="hl-1"> </span><span class="hl-3">ag_1234567890</span><br/><br/><span class="hl-7"># Dry run</span><br/><span class="hl-6">plot</span><span class="hl-1"> </span><span class="hl-3">deploy</span><span class="hl-1"> </span><span class="hl-4">--dry-run</span>
|
|
94
|
+
</code><button type="button">Copy</button></pre>
|
|
95
|
+
|
|
96
|
+
<hr>
|
|
97
|
+
<h3 id="plot-logs" class="tsd-anchor-link">plot logs<a href="#plot-logs" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><p>Stream real-time logs from an twist.</p>
|
|
98
|
+
<pre><code class="bash"><span class="hl-6">plot</span><span class="hl-1"> </span><span class="hl-3">logs</span><span class="hl-1"> [twist-id] [options]</span>
|
|
99
|
+
</code><button type="button">Copy</button></pre>
|
|
100
|
+
|
|
101
|
+
<p><strong>Options:</strong></p>
|
|
102
|
+
<ul>
|
|
103
|
+
<li><code>--id <twistId></code> - twist ID</li>
|
|
104
|
+
<li><code>--dir <directory></code> - twist directory (default: current directory)</li>
|
|
105
|
+
<li><code>--environment <env></code> - twist environment (personal, private, review) (default: personal)</li>
|
|
106
|
+
<li><code>--deploy-token <token></code> - Authentication token</li>
|
|
107
|
+
</ul>
|
|
108
|
+
<p><strong>Example:</strong></p>
|
|
109
|
+
<pre><code class="bash"><span class="hl-7"># Stream logs for an twist</span><br/><span class="hl-6">plot</span><span class="hl-1"> </span><span class="hl-3">logs</span><span class="hl-1"> </span><span class="hl-3">ag_1234567890</span><br/><br/><span class="hl-7"># Stream logs using twist in current directory</span><br/><span class="hl-6">plot</span><span class="hl-1"> </span><span class="hl-3">logs</span><span class="hl-1"> </span><span class="hl-4">--dir</span><span class="hl-1"> </span><span class="hl-3">./my-twist</span>
|
|
110
|
+
</code><button type="button">Copy</button></pre>
|
|
111
|
+
|
|
112
|
+
<hr>
|
|
113
|
+
<h2 id="priority-commands" class="tsd-anchor-link">Priority Commands<a href="#priority-commands" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2><h3 id="plot-priority-list" class="tsd-anchor-link">plot priority list<a href="#plot-priority-list" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><p>List all priorities for the authenticated user.</p>
|
|
114
|
+
<pre><code class="bash"><span class="hl-6">plot</span><span class="hl-1"> </span><span class="hl-3">priority</span><span class="hl-1"> </span><span class="hl-3">list</span>
|
|
115
|
+
</code><button type="button">Copy</button></pre>
|
|
116
|
+
|
|
117
|
+
<p><strong>Output:</strong></p>
|
|
118
|
+
<pre><code><span class="hl-2">pr_0987654321</span><span class="hl-1"> </span><span class="hl-2">Work</span><br/><span class="hl-1"> </span><span class="hl-2">pr_1111111111</span><span class="hl-1"> </span><span class="hl-2">Project</span><span class="hl-1"> </span><span class="hl-8">A</span><br/><span class="hl-1"> </span><span class="hl-2">pr_2222222222</span><span class="hl-1"> </span><span class="hl-2">Project</span><span class="hl-1"> </span><span class="hl-8">B</span><br/><span class="hl-2">pr_3333333333</span><span class="hl-1"> </span><span class="hl-2">Personal</span>
|
|
119
|
+
</code><button>Copy</button></pre>
|
|
120
|
+
|
|
121
|
+
<hr>
|
|
122
|
+
<h3 id="plot-priority-create" class="tsd-anchor-link">plot priority create<a href="#plot-priority-create" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><p>Create a new priority.</p>
|
|
123
|
+
<pre><code class="bash"><span class="hl-6">plot</span><span class="hl-1"> </span><span class="hl-3">priority</span><span class="hl-1"> </span><span class="hl-3">create</span><span class="hl-1"> [options]</span>
|
|
124
|
+
</code><button type="button">Copy</button></pre>
|
|
125
|
+
|
|
126
|
+
<p><strong>Options:</strong></p>
|
|
127
|
+
<ul>
|
|
128
|
+
<li><code>--name <name></code> - Priority name (required)</li>
|
|
129
|
+
<li><code>--parent-id <id></code> - Parent priority ID (optional)</li>
|
|
130
|
+
</ul>
|
|
131
|
+
<p><strong>Example:</strong></p>
|
|
132
|
+
<pre><code class="bash"><span class="hl-7"># Create top-level priority</span><br/><span class="hl-6">plot</span><span class="hl-1"> </span><span class="hl-3">priority</span><span class="hl-1"> </span><span class="hl-3">create</span><span class="hl-1"> </span><span class="hl-4">--name</span><span class="hl-1"> </span><span class="hl-3">"Work"</span><br/><br/><span class="hl-7"># Create nested priority</span><br/><span class="hl-6">plot</span><span class="hl-1"> </span><span class="hl-3">priority</span><span class="hl-1"> </span><span class="hl-3">create</span><span class="hl-1"> </span><span class="hl-4">--name</span><span class="hl-1"> </span><span class="hl-3">"Project A"</span><span class="hl-1"> </span><span class="hl-4">--parent-id</span><span class="hl-1"> </span><span class="hl-3">pr_0987654321</span>
|
|
133
|
+
</code><button type="button">Copy</button></pre>
|
|
134
|
+
|
|
135
|
+
<hr>
|
|
136
|
+
<h2 id="global-options" class="tsd-anchor-link">Global Options<a href="#global-options" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2><p>These options are available for all commands:</p>
|
|
137
|
+
<ul>
|
|
138
|
+
<li><code>--help</code>, <code>-h</code> - Show help for command</li>
|
|
139
|
+
<li><code>--version</code>, <code>-v</code> - Show CLI version</li>
|
|
140
|
+
<li><code>--verbose</code> - Enable verbose logging</li>
|
|
141
|
+
<li><code>--config <path></code> - Use custom config file (default: <code>~/.plot/config.json</code>)</li>
|
|
142
|
+
</ul>
|
|
143
|
+
<p><strong>Example:</strong></p>
|
|
144
|
+
<pre><code class="bash"><span class="hl-6">plot</span><span class="hl-1"> </span><span class="hl-3">deploy</span><span class="hl-1"> </span><span class="hl-4">--verbose</span><br/><span class="hl-6">plot</span><span class="hl-1"> </span><span class="hl-4">--version</span>
|
|
145
|
+
</code><button type="button">Copy</button></pre>
|
|
146
|
+
|
|
147
|
+
<hr>
|
|
148
|
+
<h2 id="configuration-file" class="tsd-anchor-link">Configuration File<a href="#configuration-file" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2><p>The CLI stores configuration in <code>~/.plot/config.json</code>:</p>
|
|
149
|
+
<pre><code class="json"><span class="hl-1">{</span><br/><span class="hl-1"> </span><span class="hl-11">"auth"</span><span class="hl-1">: {</span><br/><span class="hl-1"> </span><span class="hl-11">"token"</span><span class="hl-1">: </span><span class="hl-3">"your-api-token"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-11">"userId"</span><span class="hl-1">: </span><span class="hl-3">"user_1234567890"</span><br/><span class="hl-1"> },</span><br/><span class="hl-1"> </span><span class="hl-11">"defaults"</span><span class="hl-1">: {</span><br/><span class="hl-1"> </span><span class="hl-11">"environment"</span><span class="hl-1">: </span><span class="hl-3">"production"</span><br/><span class="hl-1"> }</span><br/><span class="hl-1">}</span>
|
|
150
|
+
</code><button type="button">Copy</button></pre>
|
|
151
|
+
|
|
152
|
+
<h3 id="customizing-defaults" class="tsd-anchor-link">Customizing Defaults<a href="#customizing-defaults" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><p>Edit the config file to set default options:</p>
|
|
153
|
+
<pre><code class="json"><span class="hl-1">{</span><br/><span class="hl-1"> </span><span class="hl-11">"defaults"</span><span class="hl-1">: {</span><br/><span class="hl-1"> </span><span class="hl-11">"environment"</span><span class="hl-1">: </span><span class="hl-3">"staging"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-11">"twistSourceDir"</span><span class="hl-1">: </span><span class="hl-3">"./dist"</span><br/><span class="hl-1"> }</span><br/><span class="hl-1">}</span>
|
|
154
|
+
</code><button type="button">Copy</button></pre>
|
|
155
|
+
|
|
156
|
+
<hr>
|
|
157
|
+
<h2 id="environment-variables" class="tsd-anchor-link">Environment Variables<a href="#environment-variables" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2><p>Configure the CLI using environment variables:</p>
|
|
158
|
+
<ul>
|
|
159
|
+
<li><code>PLOT_API_TOKEN</code> - API authentication token</li>
|
|
160
|
+
<li><code>PLOT_API_URL</code> - API endpoint (default: <code>https://api.plot.day</code>)</li>
|
|
161
|
+
<li><code>PLOT_CONFIG_PATH</code> - Custom config file path</li>
|
|
162
|
+
</ul>
|
|
163
|
+
<p><strong>Example:</strong></p>
|
|
164
|
+
<pre><code class="bash"><span class="hl-4">export</span><span class="hl-1"> </span><span class="hl-2">PLOT_API_TOKEN</span><span class="hl-1">=</span><span class="hl-2">your-token</span><br/><span class="hl-6">plot</span><span class="hl-1"> </span><span class="hl-3">deploy</span>
|
|
165
|
+
</code><button type="button">Copy</button></pre>
|
|
166
|
+
|
|
167
|
+
<hr>
|
|
168
|
+
<h2 id="common-workflows" class="tsd-anchor-link">Common Workflows<a href="#common-workflows" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2><h3 id="create-and-deploy-a-new-twist" class="tsd-anchor-link">Create and Deploy a New twist<a href="#create-and-deploy-a-new-twist" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><pre><code class="bash"><span class="hl-7"># 1. Create project</span><br/><span class="hl-6">plot</span><span class="hl-1"> </span><span class="hl-3">create</span><span class="hl-1"> </span><span class="hl-4">--name</span><span class="hl-1"> </span><span class="hl-3">my-twist</span><br/><br/><span class="hl-7"># 2. Navigate to directory</span><br/><span class="hl-6">cd</span><span class="hl-1"> </span><span class="hl-3">my-twist</span><br/><br/><span class="hl-7"># 3. Implement twist</span><br/><span class="hl-7"># Edit src/index.ts</span><br/><br/><span class="hl-7"># 4. Login (if not already authenticated)</span><br/><span class="hl-6">plot</span><span class="hl-1"> </span><span class="hl-3">login</span><br/><br/><span class="hl-7"># 5. Deploy</span><br/><span class="hl-6">npm</span><span class="hl-1"> </span><span class="hl-3">run</span><span class="hl-1"> </span><span class="hl-3">deploy</span>
|
|
169
|
+
</code><button type="button">Copy</button></pre>
|
|
170
|
+
|
|
171
|
+
<h3 id="update-an-existing-twist" class="tsd-anchor-link">Update an Existing twist<a href="#update-an-existing-twist" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><pre><code class="bash"><span class="hl-7"># 1. Make changes to src/index.ts</span><br/><br/><span class="hl-7"># 2. Build</span><br/><span class="hl-6">npm</span><span class="hl-1"> </span><span class="hl-3">run</span><span class="hl-1"> </span><span class="hl-3">build</span><br/><br/><span class="hl-7"># 3. Deploy update</span><br/><span class="hl-6">plot</span><span class="hl-1"> </span><span class="hl-3">deploy</span><span class="hl-1"> </span><span class="hl-4">--twist-id</span><span class="hl-1"> </span><span class="hl-3">ag_1234567890</span>
|
|
172
|
+
</code><button type="button">Copy</button></pre>
|
|
173
|
+
|
|
174
|
+
<h3 id="no-code-twist-deployment" class="tsd-anchor-link">No-Code twist Deployment<a href="#no-code-twist-deployment" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><pre><code class="bash"><span class="hl-7"># 1. Create plot-twist.md</span><br/><span class="hl-7"># Describe your twist in plain English</span><br/><br/><span class="hl-7"># 2. Login</span><br/><span class="hl-6">plot</span><span class="hl-1"> </span><span class="hl-3">login</span><br/><br/><span class="hl-7"># 3. Deploy directly from spec</span><br/><span class="hl-6">plot</span><span class="hl-1"> </span><span class="hl-3">deploy</span>
|
|
175
|
+
</code><button type="button">Copy</button></pre>
|
|
176
|
+
|
|
177
|
+
<hr>
|
|
178
|
+
<h2 id="troubleshooting" class="tsd-anchor-link">Troubleshooting<a href="#troubleshooting" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2><h3 id="authentication-issues" class="tsd-anchor-link">Authentication Issues<a href="#authentication-issues" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><pre><code class="bash"><span class="hl-7"># Clear saved token</span><br/><span class="hl-6">rm</span><span class="hl-1"> </span><span class="hl-3">~/.plot/config.json</span><br/><br/><span class="hl-7"># Login again</span><br/><span class="hl-6">plot</span><span class="hl-1"> </span><span class="hl-3">login</span>
|
|
179
|
+
</code><button type="button">Copy</button></pre>
|
|
180
|
+
|
|
181
|
+
<h3 id="build-errors" class="tsd-anchor-link">Build Errors<a href="#build-errors" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><pre><code class="bash"><span class="hl-7"># Check for TypeScript errors</span><br/><span class="hl-6">npm</span><span class="hl-1"> </span><span class="hl-3">run</span><span class="hl-1"> </span><span class="hl-3">build</span><br/><br/><span class="hl-7"># Or use lint command</span><br/><span class="hl-6">plot</span><span class="hl-1"> </span><span class="hl-3">lint</span>
|
|
182
|
+
</code><button type="button">Copy</button></pre>
|
|
183
|
+
|
|
184
|
+
<h3 id="deployment-failures" class="tsd-anchor-link">Deployment Failures<a href="#deployment-failures" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><pre><code class="bash"><span class="hl-7"># Try dry run first</span><br/><span class="hl-6">plot</span><span class="hl-1"> </span><span class="hl-3">deploy</span><span class="hl-1"> </span><span class="hl-4">--dry-run</span><br/><br/><span class="hl-7"># Enable verbose logging</span><br/><span class="hl-6">plot</span><span class="hl-1"> </span><span class="hl-3">deploy</span><span class="hl-1"> </span><span class="hl-4">--verbose</span>
|
|
185
|
+
</code><button type="button">Copy</button></pre>
|
|
186
|
+
|
|
187
|
+
<hr>
|
|
188
|
+
<h2 id="next-steps" class="tsd-anchor-link">Next Steps<a href="#next-steps" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2><ul>
|
|
189
|
+
<li><strong><a href="Getting_Started.html">Getting Started</a></strong> - Learn how to build twists</li>
|
|
190
|
+
<li><strong><a href="Core_Concepts.html">Core Concepts</a></strong> - Understand the twist architecture</li>
|
|
191
|
+
<li><strong><a href="Built-in_Tools.html">Built-in Tools</a></strong> - Explore available tools</li>
|
|
192
|
+
</ul>
|
|
193
|
+
</div></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#cli-reference"><span>CLI <wbr/>Reference</span></a><ul><li><a href="#table-of-contents"><span>Table of <wbr/>Contents</span></a></li><li><a href="#installation"><span>Installation</span></a></li><li><a href="#authentication"><span>Authentication</span></a></li><li><ul><li><a href="#plot-login"><span>plot login</span></a></li></ul></li><li><a href="#twist-commands"><span>twist <wbr/>Commands</span></a></li><li><ul><li><a href="#plot-create"><span>plot create</span></a></li><li><a href="#plot-generate"><span>plot generate</span></a></li><li><a href="#plot-lint"><span>plot lint</span></a></li><li><a href="#plot-deploy"><span>plot deploy</span></a></li><li><a href="#plot-logs"><span>plot logs</span></a></li></ul></li><li><a href="#priority-commands"><span>Priority <wbr/>Commands</span></a></li><li><ul><li><a href="#plot-priority-list"><span>plot priority list</span></a></li><li><a href="#plot-priority-create"><span>plot priority create</span></a></li></ul></li><li><a href="#global-options"><span>Global <wbr/>Options</span></a></li><li><a href="#configuration-file"><span>Configuration <wbr/>File</span></a></li><li><ul><li><a href="#customizing-defaults"><span>Customizing <wbr/>Defaults</span></a></li></ul></li><li><a href="#environment-variables"><span>Environment <wbr/>Variables</span></a></li><li><a href="#common-workflows"><span>Common <wbr/>Workflows</span></a></li><li><ul><li><a href="#create-and-deploy-a-new-twist"><span>Create and <wbr/>Deploy a <wbr/>New twist</span></a></li><li><a href="#update-an-existing-twist"><span>Update an <wbr/>Existing twist</span></a></li><li><a href="#no-code-twist-deployment"><span>No-<wbr/>Code twist <wbr/>Deployment</span></a></li></ul></li><li><a href="#troubleshooting"><span>Troubleshooting</span></a></li><li><ul><li><a href="#authentication-issues"><span>Authentication <wbr/>Issues</span></a></li><li><a href="#build-errors"><span>Build <wbr/>Errors</span></a></li><li><a href="#deployment-failures"><span>Deployment <wbr/>Failures</span></a></li></ul></li><li><a href="#next-steps"><span>Next <wbr/>Steps</span></a></li></ul></div></details></div><div class="site-menu"><nav id="tsd-sidebar-links" class="tsd-navigation"><a href="https://plot.day" class="tsd-nav-link">Plot</a><a href="https://github.com/plotday/plot" class="tsd-nav-link">GitHub</a><a href="https://www.npmjs.com/package/@plotday/twister" class="tsd-nav-link">NPM</a></nav><nav class="tsd-navigation"><a href="../modules.html">Creating Plot Twists</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
|