Files
terminalX/vendor/libghostty-spm/docs/api/shellcraft.html
kid aa92d0e676 初始提交:terminalX 可运行态(M0/M1/M1.5 已真机验证)
- M0: libghostty SSH 终端(渲染/输入/连接)+ 白屏修复(OutputGate) + 会话状态机/自动重连
- M1: tsnet 用户态组网 + SSH-over-tsnet(fd 桥),shell 级真机验证;R5(Go+gvisor+C+++Swift 同进程) retire
- M1.5: tmux -CC 原生 tab(MVP)
- 结构: packages/(TXCore·TXTransport), apps/TerminalX, vendor/(libghostty-spm/libssh2/mbedtls/tsnet-bridge), artifacts/
- 文档: CLAUDE.md + docs/HANDOFF.md(新会话入口)
- 环境: 认证代理→依赖 vendor 本地化;Go 在 ~/.local/go;仅模拟器/未签名
- 待续: M2 mosh, tmux 多 pane, M4 安全(host key/SE)

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
2026-07-24 10:20:46 +08:00

112 lines
3.7 KiB
HTML

<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta name="color-scheme" content="light dark">
<title>GhosttyKit · API · ShellCraftKit</title>
<link rel="stylesheet" href="../styles.css">
<link rel="stylesheet"
href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.10.0/styles/github.min.css"
integrity="sha384-eFTL69TLRZTkNfYZOLM+G04821K1qZao/4QLJbet1pP4tcF+fdXq/9CdqAbWRl/L"
crossorigin="anonymous"
media="(prefers-color-scheme: light)">
<link rel="stylesheet"
href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.10.0/styles/github-dark.min.css"
integrity="sha384-wH75j6z1lH97ZOpMOInqhgKzFkAInZPPSPlZpYKYTOqsaizPvhQZmAtLcPKXpLyH"
crossorigin="anonymous"
media="(prefers-color-scheme: dark)">
</head>
<body>
<nav class="topbar" aria-label="Primary">
<a class="home" href="../index.html">GhosttyKit</a>
<a href="../index.html">Overview</a>
<a href="../guide/index.html">Guide</a>
<a href="index.html" aria-current="page">API</a>
<a href="../architecture.html">Architecture</a>
<a href="../build.html">Build</a>
</nav>
<main>
<h1>ShellCraftKit</h1>
<nav class="on-this-page" aria-label="On this page">
<strong>On this page:</strong>
<a href="#ShellDefinition">ShellDefinition</a>
<a href="#ShellCommand">ShellCommand</a>
<a href="#ShellSession">ShellSession</a>
</nav>
<h2 id="ShellDefinition">ShellDefinition</h2>
<pre><code class="language-swift">public struct ShellDefinition: Sendable {
public let prompt: String
public let welcomeMessage: String
public let fallbackMessage: @Sendable (String) -&gt; String
public init(
prompt: String = "$ ",
welcomeMessage: String? = nil,
fallback: (@Sendable (String) -&gt; String)? = nil,
@ShellCommandBuilder _ build: () -&gt; [ShellCommand]
)
}
</code></pre>
<h2 id="ShellCommand">ShellCommand</h2>
<pre><code class="language-swift">public enum CommandResult: Sendable {
case output(String)
case clear
case exit
}
public struct CommandContext: Sendable {
public let command: String
public let arguments: String
public let username: String
public let terminalSize: InMemoryTerminalViewport
}
public struct ShellCommand: Sendable {
public let name: String
public let summary: String
public init(
_ name: String,
summary: String = "",
handler: @escaping @Sendable (CommandContext) -&gt; CommandResult
)
}
</code></pre>
<h2 id="ShellSession">ShellSession</h2>
<pre><code class="language-swift">public final class ShellSession {
public let terminalSession: InMemoryTerminalSession
public init(shell: ShellDefinition)
public func start()
}
public let defaultSandboxShell: ShellDefinition
public let sandboxShell: ShellDefinition
</code></pre>
<nav class="pager" aria-label="Sibling pages">
<a class="prev" href="themes.html">Theme catalog</a>
<a class="parent" href="index.html">↑ API</a>
<a class="next" href="../architecture.html">Architecture</a>
</nav>
<footer>
GhosttyKit · <a href="https://github.com/Lakr233/libghostty-spm">github.com/Lakr233/libghostty-spm</a>
</footer>
</main>
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.10.0/highlight.min.js"
integrity="sha384-GdEWAbCjn+ghjX0gLx7/N1hyTVmPAjdC2OvoAA0RyNcAOhqwtT8qnbCxWle2+uJX"
crossorigin="anonymous"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.10.0/languages/swift.min.js"
integrity="sha384-TfALNLT6HJzZieazgsVvFM0DzFWQsgl0d7mdwPLyg1yg7XE4QwLY4jqmJRNnI1S4"
crossorigin="anonymous"></script>
<script>hljs.highlightAll();</script>
</body>
</html>