Skip to content

Make it yours

终端窗口
pnpm scaffold

Answer five questions (Enter keeps the default):

QuestionNotes
Display nameShown in the window, Dock / taskbar, tray tooltip and settings (any language)
English slugkebab-case (e.g. my-kit), used for the package and binary name
App identifiercom.pocketark.<slug>, immutable after release (changing it makes the OS treat it as a different app)
Default accentIndigo / Teal / Amber / Rose / Blue / Grid Green
Default themedark / light

The script rewrites names in tauri.conf.json, Cargo.toml, main.rs, package.json and the docs. Then run:

终端窗口
pnpm install # refresh the package name in the lockfile
pnpm tauri dev # run under the new name

If you prefer to edit by hand, this is the exact list the script covers:

FileWhat to change
src-tauri/tauri.conf.jsonproductName, identifier, title
src-tauri/Cargo.toml[package] name (kebab), [lib] name (snake + _lib)
src-tauri/src/main.rspocketark_lib::run() → new lib name
package.jsonname
src/core/theme/index.tsDEFAULT_THEME / DEFAULT_ACCENT (optional)
README.md, START.md, AGENTS.md, src/content/about.mdyour own intro and titles
index.html<title>

The UI (sidebar / top bar) and tray tooltip read productName dynamically — no code changes needed.

There are two source files with the same artwork, differing only in frame scale / corner radius per platform convention:

SourceStyleOutputPlatform
src-tauri/icons/icon-macos.svgHIG grid padding (artwork 80.5%)icon.icns + Store tilemacOS Dock / Finder
src-tauri/icons/icon-windows.svgFull bleed (artwork fills the canvas)icon.ico + PNGsWindows taskbar / Explorer, Linux

Edit the artwork in both SVGs (keep each frame’s parameters), then regenerate:

终端窗口
pnpm icons

The script runs tauri icon twice and assembles per platform: icns / tile use the macOS version, ico / png use the Windows version, and public/icon.svg is synced. Each platform’s build picks the right format automatically.

The base repository ships two built-in plugins. Keep or remove as needed:

PluginNotesAdvice
hello-worldFull-chain demo (Rust / SQLite / HTTP / layout), 5 toolsRemove for real use
systemData maintenance (frontend-only, built-in)Keep
终端窗口
# e.g. remove the example (keep system / _template)
rm -rf plugins/hello-world

The frontend (sidebar / routes / settings) and backend (Rust commands / migrations) are scanned at build time, so deleting the directory removes it completely; migrations are scope-isolated, so one plugin’s removal never affects another.

  • pnpm scaffold has renamed everything (verify the identifier)
  • Icons replaced and regenerated
  • src/content/about.md / changelog.md have your intro and first release
  • Sample plugins removed or disabled
  • pnpm lint && pnpm build pass
  • pnpm tauri build output smoke-tested on the target platform (launch / quit / tray / maximize)