ARTICLE DETAIL

建站实战干货

来自一线的建站与推广经验沉淀,每一条都经过真实交付验证。

gogcli 文档页脚操作指南:用 `gog docs footer create` 在 Google Docs 中创建并填充页脚

2026/9/17 19:11:20 拓冰建站 浏览量
gogcli 文档页脚操作指南:用 `gog docs footer create` 在 Google Docs 中创建并填充页脚 gogcli 文档页脚操作指南用gog docs footer create在 Google Docs 中创建并填充页脚【免费下载链接】gogcliGoogle Workspace in your terminal.项目地址: https://gitcode.com/GitHub_Trending/gogcl/gogcli导读本文聚焦 gogcliGoogle Workspace in your terminal中gog docs footer create命令的完整用法它用于在 Google Docs 文档中创建页脚Footer并可选地在同一次操作中填入初始文本。文章不仅覆盖全部命令行参数还深入源码internal/cmd/docs_header_footer.go剖析其背后两次BatchUpdate调用的实现原理并结合仓库测试用例验证行为帮助你在终端、脚本与 Agent 工作流中可靠地管理文档页脚。命令定位gog docs footer家族gog docs footer是 gogcli 文档编辑命令族的一员对应 Google Docs API 中的页眉/页脚分段segment管理。命令树定义见 internal/cmd/docs_header_footer.gogog docs footer create别名add、new——创建并可选填充页脚本命令gog docs footer list别名ls——列出页脚及其分段 ID见 gog-docs-footer-listgog docs footer delete别名rm、remove、del——删除页脚见 gog-docs-footer-delete与之对称的还有gog docs header系列两者共享同一套底层实现runDocsSegmentCreate、runDocsSegmentList、runDocsSegmentDelete仅通过docsSegmentKindHeader/docsSegmentKindFooter区分目标类型。用法与别名gog docs (doc) footer (footers) create (add,new) docId [flags]要点docs可用别名docfooter可用别名footerscreate可用别名add、newdocId是位置参数必填。gogcli 会在请求前对docId做normalizeGoogleID与去空格处理空 ID 直接报错empty docId见 docs_header_footer.go无位置参数时可通过--tab指定目标标签页见下文「定位到指定标签页」。完整参数表以下参数完整继承自官方命令文档gog-docs-footer-create.md并按源码补充了默认行为说明。命令专属参数Flag类型默认说明--filestring从文件读取初始页脚文本-表示从标准输入读取--textstring初始页脚文本--tabstring按标题或 ID 定位到指定标签页参见 gog docs list-tabs--index*int64字符索引1 表示文档开头省略则默认放在文档末尾--atstring按字面文本锚定使用匹配区间起点作为插入位置--occurrence*int当--at匹配有歧义时取第 N 次匹配从 1 开始计数--match-casebool对--at匹配启用大小写敏感--at-endbool定位到文档/标签页末尾与--index、--at互斥全局/通用参数Flag类型默认说明--access-tokenstring直接使用提供的访问令牌绕过已存刷新令牌令牌约 1 小时过期-a--account--acctstring账户邮箱、别名或auto用于已认证的 Google API 命令--clientstringOAuth 客户端名称选择对应存储凭据与令牌桶--colorstringauto输出颜色auto|always|never--disable-commandsstring逗号分隔的禁用命令列表支持点路径-n--dry-run--dryrun--noop--previewbool不真正改动仅打印预期动作并成功退出--enable-commandsstring逗号分隔的启用命令前缀列表支持点路径限制 CLI 范围--enable-commands-exactstring逗号分隔的精确启用命令列表父命令不自动启用子命令-y--force--assume-yes--yesbool对破坏性命令跳过确认--gmail-no-sendboolfalse阻止 Gmail 发送操作Agent 安全-h--helpkong.helpFlag显示上下文相关帮助--homestring覆盖 gogcli 配置/数据/状态/缓存根目录等价于GOG_HOME-j--json--machineboolfalse向标准输出输出 JSON最适合脚本化--no-input--non-interactive--noninteractivebool绝不提示失败即退出适合 CI-p--plain--tsvboolfalse输出稳定可解析的文本TSV无颜色--quota-projectstring为 API 用量计费的 Google Cloud 项目发送为X-Goog-User-Project部分 API 在使用--access-token或 ADC 时要求--readonlyboolfalse运行时阻止变更类 API 请求auth add也改为申请只读 OAuth 范围--results-onlyboolJSON 模式下仅输出主结果丢弃nextPageToken等信封字段--select--pick--projectstringJSON 模式下按逗号分隔选择字段尽力而为支持点路径多数命令建议用--fields-v--verbosebool启用详细日志--versionkong.VersionFlag打印版本并退出--wrap-untrustedboolfalseJSON/raw 输出中将抓取的文本字段包上外部不可信内容标记文本来源--text与--file的解析规则页脚初始文本有两个来源二者互斥。解析逻辑位于 internal/cmd/docs_helpers.go 的resolveTextInput只传--text直接使用该字符串只传--file读取文件内容-表示从标准输入读取路径支持环境变量展开config.ExpandPath见 docs_helpers.go两者都传报错use only one of --text or --file两者都没传providedfalse命令仍会创建空页脚但不追加文本此时只发出 1 个 API 请求。注意与一般文档编辑命令不同create允许不提供文本创建空页脚而插入脚注等命令要求非空文本。该差异在源码runDocsSegmentCreate中体现if provided text ! 时才执行填充步骤见 docs_header_footer.go。定位语义页脚「创建在哪一节」页脚属于文档的分段section资源创建时通过SectionBreakLocation指定挂靠的节。gogcli 的定位选项--index、--at、--at-end、--occurrence、--match-case、--tab统一定义在DocsBodyPlacementFlags见 internal/cmd/docs_structural.go与gog docs insert、gog docs insert-footnote、gog docs insert-section-break等命令共用同一套占位解析器。行为细节见 docs_header_footer.go 与 docs_header_footer.go不指定任何定位参数目标为所选标签页的默认节section: document-default即页脚挂到该标签页首个分节指定--index/--at/--at-end先解析出具体位置再定位到包含该位置最近的SectionBreakdocsSectionBreakLocation从文档正文中向前找最近的节断点见 docs_header_footer.go目标在表格内部直接报错header/footer sections cannot be selected from inside a table--tab指定标签页标题或 ID配合--index定位到该标签页内的节。测试用例 internal/cmd/docs_header_footer_test.go 验证了「选中标签页首节」的行为当指定--tab Second时实际发出的请求体包含sectionBreakLocation:{index:0,tabId:tab-2}。底层实现两次BatchUpdate调用从源码看gog docs footer create的请求序列是先创建、后填充两步见 docs_header_footer.go第一次BatchUpdate发送CreateFooterRequest{Type: DEFAULT, SectionBreakLocation: ...}让 Docs API 创建页脚分段并返回FooterId从响应提取分段 ID遍历response.Replies找到CreateFooter.FooterIddocsCreatedSegmentID见 docs_header_footer.go若缺失则报错create footer response missing segment ID第二次BatchUpdate仅当提供了非空文本发送InsertTextRequest通过EndOfSegmentLocation{SegmentId: segmentID, TabId: tabID}把文本追加到新建页脚内部实现「创建即填充」输出结果时requests字段反映实际发出的请求次数创建 1 次填充则共 2 次。测试TestDocsHeaderCreatePopulatesReturnedSegmentdocs_header_footer_test.go精确断言了这两个请求的先后顺序与内容第一次请求必须是CreateHeader.Type DEFAULT第二次必须是InsertText且EndOfSegmentLocation.SegmentId header-1、文本与参数一致。页脚与页眉共用完全相同的代码路径仅 kind 不同因此该测试同时佐证了页脚创建的两步行为。输出格式创建成功后的默认输出为 TSV 行writeDocsSegmentMutationResult见 docs_header_footer.godocumentId docId segmentId footerId segmentType footer requests 1|2 tabId tabId # 仅当指定了标签页时出现使用--json时输出等价 JSON 对象适合脚本解析gog docs footer create DOC_ID --text Page Footer --json{documentId:DOC_ID,segmentId:kix.footer.xxx,segmentType:footer,requests:2}实战示例1. 创建空页脚gog docs footer create DOC_ID不提供文本仅创建DEFAULT类型页脚后续可用 gog docs insert / gog docs update 配合--segment footerId追加内容测试TestDocsSegmentTextCommandsPropagateSegmentID验证了分段 ID 在编辑命令间的传递。2. 创建并填充简单文本gog docs footer create DOC_ID --text Confidential — Internal use only3. 从文件读取页脚文本gog docs footer create DOC_ID --file footer.txt gog docs footer create DOC_ID --file - footer.txt # 标准输入4. 将页脚挂到指定标签页gog docs footer create DOC_ID --text Appendix footer --tab Appendix5. 先预览后执行dry-rungog docs footer create DOC_ID --text Draft --dry-run--dry-run会打印预期动作含documentId、segmentType、textBytes、定位信息而不真正改动文档见 docs_header_footer.go。6. 定位到文档末尾或指定文本之后gog docs footer create DOC_ID --text Footer --at-end gog docs footer create DOC_ID --text Footer --at REFERENCES --occurrence 1 --match-case安全与脚本化注意事项--readonly开启后运行时拦截变更类 API 请求docs footer create将无法执行适合只读巡检场景-y/--forcedelete 类命令的破坏性确认可跳过create本身不触发破坏性确认--no-inputCI 环境中不交互失败即退出避免挂起--disable-commands/--enable-commands可限制 CLI 暴露范围例如只允许docs前缀是 Agent 沙箱隔离的常用手段--gmail-no-send与页脚无关但常随全局 flag 出现用于阻断 Gmail 发送属 Agent 安全设计。使用前提需先完成 gogcli 的认证参见 安装与认证使目标账户具备该 Google Docs 文档的编辑权限命令基于 Google Docs API需要网络访问与对应 OAuth 范围--readonly认证时无法执行创建操作DOC_ID支持文档 URL 中的 ID 或纯 IDgogcli 会在请求前做规范化处理。相关命令索引父命令gog docs footer、gog docs兄弟命令gog docs footer list、gog docs footer delete对称功能gog docs header create编辑已建页脚gog docs insert、gog docs update命令总索引Command index说明本文对应的命令帮助文档由gog schema --json自动生成见 gog-docs-footer-create.md以仓库当前版本为准。【免费下载链接】gogcliGoogle Workspace in your terminal.项目地址: https://gitcode.com/GitHub_Trending/gogcl/gogcli创作声明:本文部分内容由AI辅助生成(AIGC),仅供参考