写匠写匠
返回文档
命令行

命令行入门

装进终端,找到你的项目,四组常用命令

写匠背后有一个命令行程序 aiwriter:建卡、查找、导出这些活是它在做,桌面版把它们画成了界面。 平时写作用不着它。想批量处理、写脚本,或者让 AI 编程助手替你动手,再来用它。

装进终端

打开写匠,进 设置 › 外观 › 界面 ›「命令行工具」 那一行,点「安装到终端」。 macOS 会请你输一次电脑密码。装好之后打开「终端」,敲:

aiwriter --help

看到四组命令,就装好了。它跟着写匠一起升级,不用再装第二次。

写匠还在安装盘里、或者直接从「下载」里打开的时候,这一行会先请你把写匠拖进「应用程序」。

不想要了:在终端里敲 sudo rm /usr/local/bin/aiwriter,写匠本身不受影响。

找到你的项目

项目就是一个 <书名>.aiw 文件夹,默认都在你家目录下的 aiwriter 里。 在项目文件夹里敲命令,不用说是哪一本:

cd ~/aiwriter/我的小说.aiw
aiwriter ls

在别处,就用 --project 指一下:aiwriter ls --project ~/aiwriter/我的小说.aiw

四组常用命令

aiwriter --help 把命令分成四组,每组先记住这几条就够了。

⚠️ aiwriter ls 每张卡前面那 8 位只是编号的开头,showrm 要完整的编号——用 aiwriter ls --json 查。

项目:新建、打开、多项目

aiwriter new 我的小说新建一本(落在 ~/aiwriter 下)
aiwriter projects ls列出你所有的项目,带字数、卡数

写作:卡片、大纲、查找

aiwriter ls按大纲顺序列出所有卡
aiwriter ls --json同上,带每张卡完整的编号(下面几条要用它)
aiwriter show <编号>看一张卡的正文
aiwriter add --title 第一章 --body 雨下了一整夜。新建一张卡
aiwriter find 雨在这本书里找
aiwriter rm <编号>删一张卡——进回收站,还原得回来

成品:导出

aiwriter pdf导出 PDF
aiwriter docx --out 我的小说.docx导出 Word,--out 说放在哪儿

AI 与云:问答、统计

aiwriter ask 雨夜把你写过的相关卡片摆出来(不联网)
aiwriter analyze写作统计:整体 / 字词 / 句法 / 篇章

每条命令都能加 --help 看完整用法,比如 aiwriter find --help(或 aiwriter help find)。全部命令见全部命令

下一步

想让 Claude Code、Codex 这类 AI 编程助手替你整理稿子,见让 AI 编程助手调用写匠