trae-starter
v0.0.3
Published
A CLI tool to start Trae projects with a web UI
Readme
Trae Starter
trae-starter 是一个用于快速启动和管理 Trae 项目的 CLI 工具。它提供了一个直观的 Web 界面,让你能够轻松管理工作区、创建新项目,并一键在 Trae IDE 中打开它们。此外,它也支持纯命令行的模板创建方式。
✨ 主要功能
- 可视化项目管理:启动一个本地 Web 服务,在浏览器中直观地管理你的项目。
- 命令行项目脚手架:支持通过纯命令行的方式列出可用模板、并一键生成项目。
- 工作区管理:轻松选择和切换当前的工作区目录。
- 自动更新机制:使用
web界面启动时会自动检查 npm 上的最新版本,如果有新版本会自动更新以保持最佳体验。 - 一键打开 Trae:通过
trae-cn://自定义协议,一键将项目在 Trae IDE 中打开。
🚀 快速开始 (Get Started)
最简单的使用方式是直接通过 npx 运行,无需全局安装:
# 启动可视化 Web 界面
npx trae-starter web启动后,命令行会自动在浏览器中打开 http://localhost:5050。
命令行模板脚手架
查看所有可用的模板:
npx trae-starter temp-ls从指定模板创建新项目:
npx trae-starter temp-create <template-name> [directory]<template-name>: 模板名称(例如:proto)[directory]: (可选)目标文件夹路径,如果不填则默认使用模板名称作为文件夹名。
命令行选项
-p, --port <number>: 指定 Web 服务运行的端口(默认:5050)
例如,要在 8080 端口启动服务:
npx trae-starter web -p 8080📦 安装 (可选)
如果你希望经常使用,也可以将其全局安装:
npm install -g trae-starter安装后直接运行:
trae-starter web
trae-starter temp-ls
trae-starter temp-create proto my-new-project📂 目录结构
bin/cli.js: CLI 入口文件server/: Express 后端服务代码,提供 API 接口api.js: 核心 API 路由(获取工作区、创建项目、打开 Trae 等)index.js: Web 服务器配置
public/: 前端 Web 界面静态资源templates/: 项目模板目录,用于在创建新项目时作为脚手架
🛠️ 本地开发
- 克隆仓库到本地
- 安装依赖:
npm install - 启动服务:
npm run start
📝 配置文件
工具会在用户主目录下生成一个 .trae-starter-config.json 文件,用于持久化保存你上次选择的工作区路径。
