@plotday/twister 0.57.0 → 0.58.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/README.md +53 -44
- package/bin/commands/create.js +9 -14
- package/bin/commands/create.js.map +1 -1
- package/bin/commands/deploy.js +2 -0
- package/bin/commands/deploy.js.map +1 -1
- package/bin/commands/generate.js +8 -5
- package/bin/commands/generate.js.map +1 -1
- package/bin/index.js +2 -2
- package/bin/index.js.map +1 -1
- package/bin/templates/AGENTS.template.md +110 -94
- package/bin/templates/README.template.md +36 -33
- package/cli/templates/AGENTS.template.md +110 -94
- package/cli/templates/README.template.md +36 -33
- package/dist/connector.d.ts +24 -17
- package/dist/connector.d.ts.map +1 -1
- package/dist/connector.js +19 -12
- package/dist/connector.js.map +1 -1
- package/dist/docs/assets/hierarchy.js +1 -1
- package/dist/docs/assets/navigation.js +1 -1
- package/dist/docs/assets/search.js +1 -1
- package/dist/docs/classes/index.Connector.html +66 -60
- package/dist/docs/classes/index.FileNotFoundError.html +2 -2
- package/dist/docs/classes/index.Files.html +4 -4
- package/dist/docs/classes/index.Imap.html +10 -10
- package/dist/docs/classes/index.Options.html +2 -2
- package/dist/docs/classes/index.Smtp.html +6 -6
- package/dist/docs/classes/tool.ITool.html +2 -2
- package/dist/docs/classes/tool.Tool.html +23 -23
- package/dist/docs/classes/tools_ai.AI.html +5 -5
- package/dist/docs/classes/tools_callbacks.Callbacks.html +8 -8
- package/dist/docs/classes/tools_integrations.Integrations.html +15 -15
- package/dist/docs/classes/tools_network.Network.html +9 -9
- package/dist/docs/classes/tools_plot.Plot.html +34 -33
- package/dist/docs/classes/tools_store.Store.html +8 -8
- package/dist/docs/classes/tools_tasks.Tasks.html +6 -6
- package/dist/docs/classes/tools_twists.Twists.html +12 -11
- package/dist/docs/classes/twist.Twist.html +28 -28
- package/dist/docs/documents/Building_Connectors.html +42 -28
- package/dist/docs/documents/Built-in_Tools.html +170 -67
- package/dist/docs/documents/CLI_Reference.html +68 -47
- package/dist/docs/documents/Core_Concepts.html +52 -81
- package/dist/docs/documents/Getting_Started.html +28 -31
- package/dist/docs/documents/MULTI_USER_AUTH.html +45 -0
- package/dist/docs/documents/Runtime_Environment.html +13 -12
- package/dist/docs/documents/SYNC_STRATEGIES.html +373 -0
- package/dist/docs/enums/plot.ActionType.html +9 -9
- package/dist/docs/enums/plot.ActorType.html +4 -4
- package/dist/docs/enums/plot.ConferencingProvider.html +6 -6
- package/dist/docs/enums/plot.ThemeColor.html +9 -9
- package/dist/docs/enums/tag.Tag.html +3 -3
- package/dist/docs/enums/tools_ai.AIModel.html +3 -3
- package/dist/docs/enums/tools_integrations.AuthProvider.html +13 -13
- package/dist/docs/enums/tools_plot.ContactAccess.html +2 -2
- package/dist/docs/enums/tools_plot.FocusAccess.html +3 -3
- package/dist/docs/enums/tools_plot.LinkAccess.html +3 -3
- package/dist/docs/enums/tools_plot.ThreadAccess.html +4 -4
- package/dist/docs/functions/index.Uuid.Generate.html +1 -1
- package/dist/docs/functions/utils_hash.quickHash.html +1 -1
- package/dist/docs/hierarchy.html +1 -1
- package/dist/docs/index.html +7 -8
- package/dist/docs/interfaces/tools_ai.AIRequest.html +13 -13
- package/dist/docs/interfaces/tools_ai.AIResponse.html +9 -9
- package/dist/docs/interfaces/tools_ai.FilePart.html +5 -5
- package/dist/docs/interfaces/tools_ai.ImagePart.html +4 -4
- package/dist/docs/interfaces/tools_ai.ReasoningPart.html +4 -4
- package/dist/docs/interfaces/tools_ai.RedactedReasoningPart.html +3 -3
- package/dist/docs/interfaces/tools_ai.TextPart.html +3 -3
- package/dist/docs/interfaces/tools_ai.ToolCallPart.html +5 -5
- package/dist/docs/interfaces/tools_ai.ToolExecutionOptions.html +4 -4
- package/dist/docs/interfaces/tools_ai.ToolResultPart.html +5 -5
- package/dist/docs/interfaces/tools_twists.TwistSource.html +3 -3
- package/dist/docs/interfaces/utils_types.ToolShed.html +5 -5
- package/dist/docs/media/AGENTS.md +101 -74
- package/dist/docs/modules.html +1 -1
- package/dist/docs/types/index.BooleanDef.html +2 -2
- package/dist/docs/types/index.CreateLinkDraft.html +9 -9
- package/dist/docs/types/index.ImapAddress.html +3 -3
- package/dist/docs/types/index.ImapConnectOptions.html +6 -6
- package/dist/docs/types/index.ImapFetchOptions.html +4 -4
- package/dist/docs/types/index.ImapFlagOperation.html +1 -1
- package/dist/docs/types/index.ImapMailbox.html +5 -5
- package/dist/docs/types/index.ImapMailboxStatus.html +7 -7
- package/dist/docs/types/index.ImapMessage.html +14 -14
- package/dist/docs/types/index.ImapSearchCriteria.html +9 -9
- package/dist/docs/types/index.ImapSession.html +1 -1
- package/dist/docs/types/index.NewSchedule.html +13 -13
- package/dist/docs/types/index.NewScheduleContact.html +2 -2
- package/dist/docs/types/index.NewScheduleOccurrence.html +1 -1
- package/dist/docs/types/index.NoteWriteBackResult.html +3 -3
- package/dist/docs/types/index.NumberDef.html +2 -2
- package/dist/docs/types/index.OptionDef.html +1 -1
- package/dist/docs/types/index.OptionalScopeGroup.html +6 -6
- package/dist/docs/types/index.OptionsSchema.html +1 -1
- package/dist/docs/types/index.ReactionCapabilities.html +1 -1
- package/dist/docs/types/index.ResolvedOptions.html +1 -1
- package/dist/docs/types/index.ResolvedRecipient.html +5 -5
- package/dist/docs/types/index.Schedule.html +12 -12
- package/dist/docs/types/index.ScheduleContact.html +2 -2
- package/dist/docs/types/index.ScheduleContactRole.html +1 -1
- package/dist/docs/types/index.ScheduleContactStatus.html +1 -1
- package/dist/docs/types/index.ScheduleOccurrence.html +6 -6
- package/dist/docs/types/index.ScheduleOccurrenceUpdate.html +1 -1
- package/dist/docs/types/index.ScopeConfig.html +3 -3
- package/dist/docs/types/index.SelectDef.html +2 -2
- package/dist/docs/types/index.Serializable.html +1 -1
- package/dist/docs/types/index.SmtpAddress.html +3 -3
- package/dist/docs/types/index.SmtpConnectOptions.html +7 -7
- package/dist/docs/types/index.SmtpMessage.html +12 -12
- package/dist/docs/types/index.SmtpSendResult.html +4 -4
- package/dist/docs/types/index.SmtpSession.html +1 -1
- package/dist/docs/types/index.TextDef.html +2 -2
- package/dist/docs/types/index.Uuid.html +1 -1
- package/dist/docs/types/plot.Action.html +1 -1
- package/dist/docs/types/plot.Actor.html +5 -5
- package/dist/docs/types/plot.ActorId.html +4 -4
- package/dist/docs/types/plot.Contact.html +4 -4
- package/dist/docs/types/plot.ContentType.html +1 -1
- package/dist/docs/types/plot.Focus.html +8 -8
- package/dist/docs/types/plot.FocusUpdate.html +1 -1
- package/dist/docs/types/plot.Link.html +17 -17
- package/dist/docs/types/plot.LinkUpdate.html +1 -1
- package/dist/docs/types/plot.NewActor.html +1 -1
- package/dist/docs/types/plot.NewContact.html +1 -1
- package/dist/docs/types/plot.NewFocus.html +1 -1
- package/dist/docs/types/plot.NewLink.html +5 -2
- package/dist/docs/types/plot.NewLinkWithNotes.html +1 -1
- package/dist/docs/types/plot.NewNote.html +1 -1
- package/dist/docs/types/plot.NewReactions.html +1 -1
- package/dist/docs/types/plot.NewTags.html +1 -1
- package/dist/docs/types/plot.NewThread.html +1 -1
- package/dist/docs/types/plot.NewThreadWithNotes.html +1 -1
- package/dist/docs/types/plot.Note.html +1 -1
- package/dist/docs/types/plot.NoteUpdate.html +1 -1
- package/dist/docs/types/plot.PlanOperation.html +1 -1
- package/dist/docs/types/plot.Reaction.html +3 -3
- package/dist/docs/types/plot.Reactions.html +1 -1
- package/dist/docs/types/plot.Tags.html +1 -1
- package/dist/docs/types/plot.Thread.html +1 -1
- package/dist/docs/types/plot.ThreadAccessLevel.html +1 -1
- package/dist/docs/types/plot.ThreadCommon.html +6 -6
- package/dist/docs/types/plot.ThreadFilter.html +2 -2
- package/dist/docs/types/plot.ThreadMeta.html +1 -1
- package/dist/docs/types/plot.ThreadType.html +1 -1
- package/dist/docs/types/plot.ThreadUpdate.html +1 -1
- package/dist/docs/types/plot.ThreadWithNotes.html +1 -1
- package/dist/docs/types/tools_ai.AIAssistantMessage.html +2 -2
- package/dist/docs/types/tools_ai.AICapabilities.html +4 -4
- package/dist/docs/types/tools_ai.AIMessage.html +1 -1
- package/dist/docs/types/tools_ai.AIOptions.html +2 -2
- package/dist/docs/types/tools_ai.AISource.html +1 -1
- package/dist/docs/types/tools_ai.AISystemMessage.html +2 -2
- package/dist/docs/types/tools_ai.AITool.html +1 -1
- package/dist/docs/types/tools_ai.AIToolMessage.html +2 -2
- package/dist/docs/types/tools_ai.AIToolSet.html +1 -1
- package/dist/docs/types/tools_ai.AIUsage.html +5 -5
- package/dist/docs/types/tools_ai.AIUserMessage.html +2 -2
- package/dist/docs/types/tools_ai.DataContent.html +1 -1
- package/dist/docs/types/tools_ai.ModelPreferences.html +5 -5
- package/dist/docs/types/tools_callbacks.Callback.html +2 -2
- package/dist/docs/types/tools_integrations.ArchiveLinkFilter.html +5 -5
- package/dist/docs/types/tools_integrations.ArchiveNotesFilter.html +2 -2
- package/dist/docs/types/tools_integrations.AuthToken.html +6 -5
- package/dist/docs/types/tools_integrations.Authorization.html +4 -4
- package/dist/docs/types/tools_integrations.Channel.html +6 -6
- package/dist/docs/types/tools_integrations.ComposeConfig.html +4 -4
- package/dist/docs/types/tools_integrations.ContactRoleConfig.html +5 -5
- package/dist/docs/types/tools_integrations.LinkTypeConfig.html +21 -21
- package/dist/docs/types/tools_integrations.NewCustomEmoji.html +8 -8
- package/dist/docs/types/tools_integrations.StatusIcon.html +1 -1
- package/dist/docs/types/tools_integrations.SyncContext.html +4 -4
- package/dist/docs/types/tools_network.WebhookRequest.html +6 -6
- package/dist/docs/types/tools_plot.LinkFilter.html +5 -5
- package/dist/docs/types/tools_plot.LinkSearchResult.html +1 -1
- package/dist/docs/types/tools_plot.NoteIntentHandler.html +4 -4
- package/dist/docs/types/tools_plot.NoteSearchResult.html +1 -1
- package/dist/docs/types/tools_plot.SearchOptions.html +4 -4
- package/dist/docs/types/tools_plot.SearchResult.html +1 -1
- package/dist/docs/types/tools_twists.Log.html +2 -2
- package/dist/docs/types/tools_twists.TwistPermissions.html +1 -1
- package/dist/docs/types/utils_types.BuiltInTools.html +2 -2
- package/dist/docs/types/utils_types.ExtractBuildReturn.html +1 -1
- package/dist/docs/types/utils_types.InferOptions.html +1 -1
- package/dist/docs/types/utils_types.InferTools.html +1 -1
- package/dist/docs/types/utils_types.JSONValue.html +1 -1
- package/dist/docs/types/utils_types.PromiseValues.html +1 -1
- package/dist/docs/types/utils_types.ToolBuilder.html +1 -1
- package/dist/docs/variables/tools_plot.SEARCH_DEFAULT_LIMIT.html +1 -1
- package/dist/docs/variables/tools_plot.SEARCH_MAX_LIMIT.html +1 -1
- package/dist/facets.d.ts +30 -0
- package/dist/facets.d.ts.map +1 -0
- package/dist/facets.js +16 -0
- package/dist/facets.js.map +1 -0
- package/dist/llm-docs/connector.d.ts +1 -1
- package/dist/llm-docs/connector.d.ts.map +1 -1
- package/dist/llm-docs/connector.js +1 -1
- package/dist/llm-docs/connector.js.map +1 -1
- package/dist/llm-docs/facets.d.ts +9 -0
- package/dist/llm-docs/facets.d.ts.map +1 -0
- package/dist/llm-docs/facets.js +8 -0
- package/dist/llm-docs/facets.js.map +1 -0
- package/dist/llm-docs/index.d.ts.map +1 -1
- package/dist/llm-docs/index.js +2 -0
- package/dist/llm-docs/index.js.map +1 -1
- package/dist/llm-docs/plot.d.ts +1 -1
- package/dist/llm-docs/plot.d.ts.map +1 -1
- package/dist/llm-docs/plot.js +1 -1
- package/dist/llm-docs/plot.js.map +1 -1
- package/dist/llm-docs/tool.d.ts +1 -1
- package/dist/llm-docs/tool.d.ts.map +1 -1
- package/dist/llm-docs/tool.js +1 -1
- package/dist/llm-docs/tool.js.map +1 -1
- package/dist/llm-docs/tools/ai.d.ts +1 -1
- package/dist/llm-docs/tools/ai.d.ts.map +1 -1
- package/dist/llm-docs/tools/ai.js +1 -1
- package/dist/llm-docs/tools/ai.js.map +1 -1
- package/dist/llm-docs/tools/callbacks.d.ts +1 -1
- package/dist/llm-docs/tools/callbacks.d.ts.map +1 -1
- package/dist/llm-docs/tools/callbacks.js +1 -1
- package/dist/llm-docs/tools/callbacks.js.map +1 -1
- package/dist/llm-docs/tools/files.d.ts +1 -1
- package/dist/llm-docs/tools/files.d.ts.map +1 -1
- package/dist/llm-docs/tools/files.js +1 -1
- package/dist/llm-docs/tools/files.js.map +1 -1
- package/dist/llm-docs/tools/imap.d.ts +1 -1
- package/dist/llm-docs/tools/imap.d.ts.map +1 -1
- package/dist/llm-docs/tools/imap.js +1 -1
- package/dist/llm-docs/tools/imap.js.map +1 -1
- package/dist/llm-docs/tools/integrations.d.ts +1 -1
- package/dist/llm-docs/tools/integrations.d.ts.map +1 -1
- package/dist/llm-docs/tools/integrations.js +1 -1
- package/dist/llm-docs/tools/integrations.js.map +1 -1
- package/dist/llm-docs/tools/network.d.ts +1 -1
- package/dist/llm-docs/tools/network.d.ts.map +1 -1
- package/dist/llm-docs/tools/network.js +1 -1
- package/dist/llm-docs/tools/network.js.map +1 -1
- package/dist/llm-docs/tools/plot.d.ts +1 -1
- package/dist/llm-docs/tools/plot.d.ts.map +1 -1
- package/dist/llm-docs/tools/plot.js +1 -1
- package/dist/llm-docs/tools/plot.js.map +1 -1
- package/dist/llm-docs/tools/smtp.d.ts +1 -1
- package/dist/llm-docs/tools/smtp.d.ts.map +1 -1
- package/dist/llm-docs/tools/smtp.js +1 -1
- package/dist/llm-docs/tools/smtp.js.map +1 -1
- package/dist/llm-docs/tools/tasks.d.ts +1 -1
- package/dist/llm-docs/tools/tasks.d.ts.map +1 -1
- package/dist/llm-docs/tools/tasks.js +1 -1
- package/dist/llm-docs/tools/tasks.js.map +1 -1
- package/dist/llm-docs/tools/twists.d.ts +1 -1
- package/dist/llm-docs/tools/twists.d.ts.map +1 -1
- package/dist/llm-docs/tools/twists.js +1 -1
- package/dist/llm-docs/tools/twists.js.map +1 -1
- package/dist/llm-docs/twist-guide-template.d.ts +1 -1
- package/dist/llm-docs/twist-guide-template.d.ts.map +1 -1
- package/dist/llm-docs/twist-guide-template.js +1 -1
- package/dist/llm-docs/twist-guide-template.js.map +1 -1
- package/dist/llm-docs/twist.d.ts +1 -1
- package/dist/llm-docs/twist.d.ts.map +1 -1
- package/dist/llm-docs/twist.js +1 -1
- package/dist/llm-docs/twist.js.map +1 -1
- package/dist/plot.d.ts +15 -8
- package/dist/plot.d.ts.map +1 -1
- package/dist/plot.js.map +1 -1
- package/dist/tool.d.ts +4 -4
- package/dist/tool.js +4 -4
- package/dist/tools/ai.d.ts +12 -13
- package/dist/tools/ai.d.ts.map +1 -1
- package/dist/tools/ai.js +8 -9
- package/dist/tools/ai.js.map +1 -1
- package/dist/tools/callbacks.d.ts +1 -1
- package/dist/tools/files.d.ts +2 -2
- package/dist/tools/imap.d.ts +1 -1
- package/dist/tools/imap.js +1 -1
- package/dist/tools/integrations.d.ts +2 -1
- package/dist/tools/integrations.d.ts.map +1 -1
- package/dist/tools/network.d.ts +5 -5
- package/dist/tools/plot.d.ts +42 -37
- package/dist/tools/plot.d.ts.map +1 -1
- package/dist/tools/plot.js +16 -12
- package/dist/tools/plot.js.map +1 -1
- package/dist/tools/smtp.d.ts +1 -1
- package/dist/tools/smtp.js +1 -1
- package/dist/tools/tasks.d.ts +6 -8
- package/dist/tools/tasks.d.ts.map +1 -1
- package/dist/tools/tasks.js +5 -7
- package/dist/tools/tasks.js.map +1 -1
- package/dist/tools/twists.d.ts +15 -14
- package/dist/tools/twists.d.ts.map +1 -1
- package/dist/tools/twists.js +2 -2
- package/dist/tools/twists.js.map +1 -1
- package/dist/twist-guide.d.ts +1 -1
- package/dist/twist-guide.d.ts.map +1 -1
- package/dist/twist.d.ts +2 -2
- package/dist/twist.js +2 -2
- package/package.json +6 -1
- package/src/connector.ts +23 -16
- package/src/facets.ts +40 -0
- package/src/llm-docs/connector.ts +1 -1
- package/src/llm-docs/facets.ts +8 -0
- package/src/llm-docs/index.ts +2 -0
- package/src/llm-docs/plot.ts +1 -1
- package/src/llm-docs/tool.ts +1 -1
- package/src/llm-docs/tools/ai.ts +1 -1
- package/src/llm-docs/tools/callbacks.ts +1 -1
- package/src/llm-docs/tools/files.ts +1 -1
- package/src/llm-docs/tools/imap.ts +1 -1
- package/src/llm-docs/tools/integrations.ts +1 -1
- package/src/llm-docs/tools/network.ts +1 -1
- package/src/llm-docs/tools/plot.ts +1 -1
- package/src/llm-docs/tools/smtp.ts +1 -1
- package/src/llm-docs/tools/tasks.ts +1 -1
- package/src/llm-docs/tools/twists.ts +1 -1
- package/src/llm-docs/twist-guide-template.ts +1 -1
- package/src/llm-docs/twist.ts +1 -1
- package/src/plot.ts +15 -8
- package/src/tool.ts +4 -4
- package/src/tools/ai.ts +12 -13
- package/src/tools/callbacks.ts +1 -1
- package/src/tools/files.ts +2 -2
- package/src/tools/imap.ts +1 -1
- package/src/tools/integrations.ts +2 -1
- package/src/tools/network.ts +5 -5
- package/src/tools/plot.ts +42 -37
- package/src/tools/smtp.ts +1 -1
- package/src/tools/tasks.ts +6 -8
- package/src/tools/twists.ts +15 -14
- package/src/twist.ts +2 -2
- package/dist/docs/media/MULTI_USER_AUTH.md +0 -116
- package/dist/docs/media/SYNC_STRATEGIES.md +0 -818
|
@@ -7,7 +7,7 @@
|
|
|
7
7
|
<li><a href="#global-options">Global Options</a></li>
|
|
8
8
|
</ul>
|
|
9
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
|
|
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 Twist Creator package:</p>
|
|
11
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
12
|
</code><button type="button">Copy</button></pre>
|
|
13
13
|
|
|
@@ -22,7 +22,7 @@
|
|
|
22
22
|
<li>After authentication, save your API token locally</li>
|
|
23
23
|
<li>Enable deploying and managing twists</li>
|
|
24
24
|
</ol>
|
|
25
|
-
<p><strong>Token Storage</strong>: The token is
|
|
25
|
+
<p><strong>Token Storage</strong>: The token is saved per API host at <code>~/.config/plot/credentials/<api-host>/token</code> (e.g. <code>~/.config/plot/credentials/api.plot.day/token</code>). On Windows it is stored under <code>%APPDATA%\plot\credentials</code>.</p>
|
|
26
26
|
<hr>
|
|
27
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
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>
|
|
@@ -30,18 +30,21 @@
|
|
|
30
30
|
|
|
31
31
|
<p><strong>Options:</strong></p>
|
|
32
32
|
<ul>
|
|
33
|
-
<li><code
|
|
33
|
+
<li><code>-n, --name <name></code> - Package name (kebab-case)</li>
|
|
34
34
|
<li><code>--display-name <name></code> - Human-readable display name</li>
|
|
35
|
-
<li><code
|
|
35
|
+
<li><code>-d, --dir <directory></code> - Output directory (default: a new directory named after the package)</li>
|
|
36
|
+
<li><code>--connector</code> - Create a connector instead of a twist</li>
|
|
36
37
|
</ul>
|
|
38
|
+
<p>If <code>--name</code> and <code>--display-name</code> are not both provided, the command prompts for them interactively.</p>
|
|
37
39
|
<p><strong>Example:</strong></p>
|
|
38
40
|
<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
41
|
</code><button type="button">Copy</button></pre>
|
|
40
42
|
|
|
41
43
|
<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"
|
|
44
|
+
<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-8">README</span><span class="hl-1">.</span><span class="hl-2">md</span><br/><span class="hl-1">├── </span><span class="hl-8">AGENTS</span><span class="hl-1">.</span><span class="hl-2">md</span><br/><span class="hl-1">├── </span><span class="hl-8">CLAUDE</span><span class="hl-1">.</span><span class="hl-2">md</span><br/><span class="hl-1">└── .</span><span class="hl-2">gitignore</span>
|
|
43
45
|
</code><button>Copy</button></pre>
|
|
44
46
|
|
|
47
|
+
<p>It also initializes a git repository and installs dependencies with the detected package manager.</p>
|
|
45
48
|
<hr>
|
|
46
49
|
<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
50
|
<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>
|
|
@@ -52,7 +55,7 @@
|
|
|
52
55
|
<li><code>-d, --dir <directory></code> - Twist directory to generate in (default: current directory)</li>
|
|
53
56
|
<li><code>--spec <file></code> - Spec file to generate from (default: <code>plot-twist.md</code> inside the twist directory)</li>
|
|
54
57
|
<li><code>--id <twistId></code> - Twist ID (reads <code>plotTwistId</code> from <code>package.json</code> if present, otherwise generates a new UUID)</li>
|
|
55
|
-
<li><code>--deploy-token <token></code> - Authentication token (falls back to <code>PLOT_DEPLOY_TOKEN</code> env var
|
|
58
|
+
<li><code>--deploy-token <token></code> - Authentication token (falls back to the <code>PLOT_DEPLOY_TOKEN</code> env var, <code>DEPLOY_TOKEN</code> in <code>.env</code>, or the token saved by <code>plot login</code>)</li>
|
|
56
59
|
</ul>
|
|
57
60
|
<p>If existing files would be overwritten, the command prompts before proceeding. On success it writes <code>package.json</code>, <code>tsconfig.json</code>, <code>README.md</code>, <code>AGENTS.md</code>, <code>CLAUDE.md</code>, and the generated source files into <code>src/</code>, then runs <code>pnpm install</code> (or the detected package manager).</p>
|
|
58
61
|
<p><strong>Example:</strong></p>
|
|
@@ -66,49 +69,65 @@
|
|
|
66
69
|
|
|
67
70
|
<p><strong>Options:</strong></p>
|
|
68
71
|
<ul>
|
|
69
|
-
<li><code
|
|
72
|
+
<li><code>-d, --dir <directory></code> - twist directory (default: current directory)</li>
|
|
70
73
|
</ul>
|
|
71
74
|
<p><strong>Example:</strong></p>
|
|
72
75
|
<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>
|
|
73
76
|
</code><button type="button">Copy</button></pre>
|
|
74
77
|
|
|
75
78
|
<hr>
|
|
76
|
-
<h3 id="plot-
|
|
79
|
+
<h3 id="plot-build" class="tsd-anchor-link">plot build<a href="#plot-build" 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>Bundle the twist without deploying.</p>
|
|
80
|
+
<pre><code class="bash"><span class="hl-6">plot</span><span class="hl-1"> </span><span class="hl-3">build</span><span class="hl-1"> [options]</span>
|
|
81
|
+
</code><button type="button">Copy</button></pre>
|
|
82
|
+
|
|
83
|
+
<p><strong>Options:</strong></p>
|
|
84
|
+
<ul>
|
|
85
|
+
<li><code>-d, --dir <directory></code> - twist directory (default: current directory)</li>
|
|
86
|
+
</ul>
|
|
87
|
+
<p>Writes the bundle to <code>build/index.js</code> and prints its size. Useful for verifying the build locally or in CI pipelines that separate build and deploy steps.</p>
|
|
88
|
+
<p><strong>Example:</strong></p>
|
|
89
|
+
<pre><code class="bash"><span class="hl-6">plot</span><span class="hl-1"> </span><span class="hl-3">build</span><span class="hl-1"> </span><span class="hl-4">--dir</span><span class="hl-1"> </span><span class="hl-3">./my-twist</span>
|
|
90
|
+
</code><button type="button">Copy</button></pre>
|
|
91
|
+
|
|
92
|
+
<hr>
|
|
93
|
+
<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 a twist to Plot.</p>
|
|
77
94
|
<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>
|
|
78
95
|
</code><button type="button">Copy</button></pre>
|
|
79
96
|
|
|
80
97
|
<p><strong>Options:</strong></p>
|
|
81
98
|
<ul>
|
|
82
|
-
<li><code
|
|
83
|
-
<li><code>--
|
|
84
|
-
<li><code>--
|
|
85
|
-
<li><code>--
|
|
86
|
-
<li><code>--
|
|
99
|
+
<li><code>-d, --dir <directory></code> - twist directory (default: current directory)</li>
|
|
100
|
+
<li><code>--id <twistId></code> - Twist ID (default: <code>plotTwistId</code> from <code>package.json</code>)</li>
|
|
101
|
+
<li><code>--name <name></code> - twist name (default: <code>displayName</code> from <code>package.json</code>)</li>
|
|
102
|
+
<li><code>--description <description></code> - twist description (default: <code>description</code> from <code>package.json</code>; required for non-personal environments)</li>
|
|
103
|
+
<li><code>--deploy-token <token></code> - Authentication token (falls back to the <code>PLOT_DEPLOY_TOKEN</code> env var, <code>DEPLOY_TOKEN</code> in <code>.env</code>, or the token saved by <code>plot login</code>)</li>
|
|
104
|
+
<li><code>-e, --environment <env></code> - Deployment environment: <code>personal</code>, <code>private</code>, <code>review</code>, or <code>public</code> (default: <code>personal</code>)</li>
|
|
87
105
|
<li><code>--dry-run</code> - Validate without deploying</li>
|
|
88
106
|
</ul>
|
|
89
107
|
<p><strong>Behavior:</strong></p>
|
|
90
108
|
<ul>
|
|
91
|
-
<li>
|
|
92
|
-
<li>
|
|
109
|
+
<li>Type-checks the code (<code>tsc --noEmit</code>), bundles it, and uploads it to Plot</li>
|
|
110
|
+
<li>If there is no <code>package.json</code> but a <code>plot-twist.md</code> spec exists: generates the twist from the spec first, then deploys</li>
|
|
111
|
+
<li>Non-personal environments require a description and a publisher (resolved from <code>publisher</code> in <code>package.json</code>, or selected/created interactively)</li>
|
|
93
112
|
</ul>
|
|
94
113
|
<p><strong>Example:</strong></p>
|
|
95
|
-
<pre><code class="bash"><span class="hl-7"># Deploy
|
|
114
|
+
<pre><code class="bash"><span class="hl-7"># Deploy (twist ID is read from package.json)</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"># Deploy to a shared environment</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">--environment</span><span class="hl-1"> </span><span class="hl-3">private</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>
|
|
96
115
|
</code><button type="button">Copy</button></pre>
|
|
97
116
|
|
|
98
117
|
<hr>
|
|
99
|
-
<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
|
|
118
|
+
<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 a twist.</p>
|
|
100
119
|
<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>
|
|
101
120
|
</code><button type="button">Copy</button></pre>
|
|
102
121
|
|
|
103
122
|
<p><strong>Options:</strong></p>
|
|
104
123
|
<ul>
|
|
105
|
-
<li><code>--id <twistId></code> - twist ID</li>
|
|
106
|
-
<li><code
|
|
107
|
-
<li><code
|
|
124
|
+
<li><code>--id <twistId></code> - twist ID (when omitted, read from <code>plotTwistId</code> in <code>package.json</code>)</li>
|
|
125
|
+
<li><code>-d, --dir <directory></code> - twist directory (default: current directory)</li>
|
|
126
|
+
<li><code>-e, --environment <env></code> - twist environment: <code>personal</code>, <code>private</code>, <code>review</code>, or <code>public</code> (default: <code>personal</code>)</li>
|
|
108
127
|
<li><code>--deploy-token <token></code> - Authentication token</li>
|
|
109
128
|
</ul>
|
|
110
129
|
<p><strong>Example:</strong></p>
|
|
111
|
-
<pre><code class="bash"><span class="hl-7"># Stream logs for
|
|
130
|
+
<pre><code class="bash"><span class="hl-7"># Stream logs for a twist by ID</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">123e4567-e89b-42d3-a456-426614174000</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>
|
|
112
131
|
</code><button type="button">Copy</button></pre>
|
|
113
132
|
|
|
114
133
|
<hr>
|
|
@@ -117,7 +136,7 @@
|
|
|
117
136
|
</code><button type="button">Copy</button></pre>
|
|
118
137
|
|
|
119
138
|
<p><strong>Output:</strong></p>
|
|
120
|
-
<pre><code><span class="hl-2">
|
|
139
|
+
<pre><code><span class="hl-8">ID</span><span class="hl-1"> </span><span class="hl-2">Parent</span><span class="hl-1"> </span><span class="hl-8">ID</span><span class="hl-1"> </span><span class="hl-2">Title</span><br/><span class="hl-1">------------------------------------------------------------------------------------</span><br/><span class="hl-1">6</span><span class="hl-2">e1f0336</span><span class="hl-1">-... (</span><span class="hl-2">root</span><span class="hl-1">) </span><span class="hl-2">Work</span><br/><span class="hl-1">9</span><span class="hl-2">b2c4a18</span><span class="hl-1">-... 6</span><span class="hl-2">e1f0336</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">0</span><span class="hl-2">a7d92e4</span><span class="hl-1">-... (</span><span class="hl-2">root</span><span class="hl-1">) </span><span class="hl-2">Personal</span><br/><br/><span class="hl-15">Total</span><span class="hl-1">: </span><span class="hl-14">3</span><span class="hl-1"> </span><span class="hl-2">priorities</span>
|
|
121
140
|
</code><button>Copy</button></pre>
|
|
122
141
|
|
|
123
142
|
<hr>
|
|
@@ -127,63 +146,65 @@
|
|
|
127
146
|
|
|
128
147
|
<p><strong>Options:</strong></p>
|
|
129
148
|
<ul>
|
|
130
|
-
<li><code>--name <name></code> - Priority name (
|
|
131
|
-
<li><code>--parent-id <id></code> - Parent priority ID (
|
|
149
|
+
<li><code>--name <name></code> - Priority name (prompted for if omitted)</li>
|
|
150
|
+
<li><code>--parent-id <id></code> - Parent priority ID, a UUID (prompted for if omitted; leave empty for a root priority)</li>
|
|
132
151
|
</ul>
|
|
133
152
|
<p><strong>Example:</strong></p>
|
|
134
|
-
<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">
|
|
153
|
+
<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">6e1f0336-58d4-4f5a-9c2b-7a1d3e8f0b42</span>
|
|
135
154
|
</code><button type="button">Copy</button></pre>
|
|
136
155
|
|
|
137
156
|
<hr>
|
|
138
157
|
<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>
|
|
139
158
|
<ul>
|
|
140
|
-
<li><code
|
|
141
|
-
<li><code
|
|
142
|
-
<li><code>--verbose</code> - Enable verbose logging</li>
|
|
143
|
-
<li><code>--config <path></code> - Use custom config file (default: <code>~/.plot/config.json</code>)</li>
|
|
159
|
+
<li><code>-h, --help</code> - Show help for command</li>
|
|
160
|
+
<li><code>-V, --version</code> - Show CLI version</li>
|
|
144
161
|
</ul>
|
|
145
162
|
<p><strong>Example:</strong></p>
|
|
146
|
-
<pre><code class="bash"><span class="hl-6">plot</span><span class="hl-1"> </span><span class="hl-
|
|
163
|
+
<pre><code class="bash"><span class="hl-6">plot</span><span class="hl-1"> </span><span class="hl-4">--version</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">--help</span>
|
|
147
164
|
</code><button type="button">Copy</button></pre>
|
|
148
165
|
|
|
149
166
|
<hr>
|
|
150
|
-
<h2 id="
|
|
151
|
-
<
|
|
152
|
-
</code
|
|
153
|
-
|
|
154
|
-
|
|
155
|
-
<
|
|
156
|
-
|
|
157
|
-
|
|
167
|
+
<h2 id="stored-credentials" class="tsd-anchor-link">Stored Credentials<a href="#stored-credentials" 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 does not use a configuration file. Credentials are stored in two places:</p>
|
|
168
|
+
<ul>
|
|
169
|
+
<li><strong>Login token</strong>: <code>plot login</code> saves your token per API host at <code>~/.config/plot/credentials/<api-host>/token</code> (Windows: <code>%APPDATA%\plot\credentials\<api-host>\token</code>)</li>
|
|
170
|
+
<li><strong>Deploy token</strong>: a <code>DEPLOY_TOKEN</code> entry in the twist directory's <code>.env</code> file (written automatically if you enter a token when prompted)</li>
|
|
171
|
+
</ul>
|
|
172
|
+
<p>When a command needs a token, it resolves one in this order:</p>
|
|
173
|
+
<ol>
|
|
174
|
+
<li><code>--deploy-token</code> flag</li>
|
|
175
|
+
<li><code>PLOT_DEPLOY_TOKEN</code> environment variable</li>
|
|
176
|
+
<li><code>DEPLOY_TOKEN</code> in the twist directory's <code>.env</code> file</li>
|
|
177
|
+
<li>The saved login token for the current API host</li>
|
|
178
|
+
</ol>
|
|
158
179
|
<hr>
|
|
159
180
|
<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>
|
|
160
181
|
<ul>
|
|
161
|
-
<li><code>
|
|
182
|
+
<li><code>PLOT_DEPLOY_TOKEN</code> - API authentication token</li>
|
|
162
183
|
<li><code>PLOT_API_URL</code> - API endpoint (default: <code>https://api.plot.day</code>)</li>
|
|
163
|
-
<li><code>
|
|
184
|
+
<li><code>PLOT_SITE_URL</code> - Site endpoint used by <code>plot login</code> (default: <code>https://plot.day</code>)</li>
|
|
164
185
|
</ul>
|
|
165
186
|
<p><strong>Example:</strong></p>
|
|
166
|
-
<pre><code class="bash"><span class="hl-4">export</span><span class="hl-1"> </span><span class="hl-2">
|
|
187
|
+
<pre><code class="bash"><span class="hl-4">export</span><span class="hl-1"> </span><span class="hl-2">PLOT_DEPLOY_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>
|
|
167
188
|
</code><button type="button">Copy</button></pre>
|
|
168
189
|
|
|
169
190
|
<hr>
|
|
170
|
-
<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>
|
|
191
|
+
<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><span class="hl-1"> </span><span class="hl-4">--display-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>
|
|
171
192
|
</code><button type="button">Copy</button></pre>
|
|
172
193
|
|
|
173
|
-
<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.
|
|
194
|
+
<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. Check for 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">lint</span><br/><br/><span class="hl-7"># 3. Deploy update (twist ID is read from plotTwistId in package.json)</span><br/><span class="hl-6">plot</span><span class="hl-1"> </span><span class="hl-3">deploy</span>
|
|
174
195
|
</code><button type="button">Copy</button></pre>
|
|
175
196
|
|
|
176
197
|
<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>
|
|
177
198
|
</code><button type="button">Copy</button></pre>
|
|
178
199
|
|
|
179
200
|
<hr>
|
|
180
|
-
<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/
|
|
201
|
+
<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">~/.config/plot/credentials/api.plot.day/token</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>
|
|
181
202
|
</code><button type="button">Copy</button></pre>
|
|
182
203
|
|
|
183
|
-
<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">
|
|
204
|
+
<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">plot</span><span class="hl-1"> </span><span class="hl-3">lint</span><br/><br/><span class="hl-7"># Or check that the bundle builds</span><br/><span class="hl-6">plot</span><span class="hl-1"> </span><span class="hl-3">build</span>
|
|
184
205
|
</code><button type="button">Copy</button></pre>
|
|
185
206
|
|
|
186
|
-
<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">#
|
|
207
|
+
<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"># After deploying, stream logs to debug runtime issues</span><br/><span class="hl-6">plot</span><span class="hl-1"> </span><span class="hl-3">logs</span>
|
|
187
208
|
</code><button type="button">Copy</button></pre>
|
|
188
209
|
|
|
189
210
|
<hr>
|
|
@@ -192,4 +213,4 @@
|
|
|
192
213
|
<li><strong><a href="Core_Concepts.html">Core Concepts</a></strong> - Understand the twist architecture</li>
|
|
193
214
|
<li><strong><a href="Built-in_Tools.html">Built-in Tools</a></strong> - Explore available tools</li>
|
|
194
215
|
</ul>
|
|
195
|
-
</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="#
|
|
216
|
+
</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-build"><span>plot build</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="#stored-credentials"><span>Stored <wbr/>Credentials</span></a></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>
|