快速参考¶

# 从源码构建
cargo build --release

# 安装 CLI
cargo install --path shortener-cli

# Docker
docker compose up -d

# 服务器
cargo run -p shortener-server

# CLI
shortener-cli --help

# 一键启动：自动准备开发密钥 → 等待后端探活 → 启动前端 Vite dev server
just dev

# 行为说明（对齐 acmecast 开发流程）：
#   - 未导出 JWT_SECRET / ADMIN__PASSWORD_HASH 时自动生成开发默认值
#     （管理员 admin / 密码 dev；也可自行 export 覆盖）
#   - 后端 :8080 探活通过后才启动 Vite；后端启动失败则终止并输出日志
#   - Vite 端口取 VITE_DEV_PORT（缺省 8000），strictPort 开启：
#     端口被占用时显式报错退出，不静默漂移
#   - /api 代理到 http://127.0.0.1:8080（务必写 127.0.0.1 而非 localhost，
#     避免 Node ≥17 将 localhost 解析为 IPv6 ::1 导致代理失败）

# 访问
#   页面（Vite 热更新）：http://localhost:8000/
#   后端 API 直连：      http://localhost:8080/go/

# 停止调试环境（二选一）：
#   1. 运行 just dev 的终端按 Ctrl-C（trap 自动回收后端进程组）
#   2. 另开终端执行（后端残留/终端被强杀时适用）：
just dev-stop

# 查看文档
make docs              # 或 just docs

# 构建文档
make docs-build        # 或 just docs-build

# 部署文档
just docs-deploy

# 格式化代码
cargo fmt

# 代码检查
cargo clippy

# 运行测试
cargo test

# 监视更改
cargo watch -x 'run -p shortener-server'

# 构建统一镜像（前端 + 后端）
just docker-build

# 运行（SQLite + Redis，可选启用 postgres/mysql profile）
just docker-run

# 查看日志
just docker-logs

# 停止
just docker-stop

# 所有测试
cargo test

# 特定包
cargo test -p shortener-server

# 基准测试
cargo bench

# 初始化
shortener-cli init

# 创建短链接
shortener-cli create https://example.com

# 获取详情
shortener-cli get <code>

# 列出所有
shortener-cli list --all

# 更新
shortener-cli update <code> --ourl <new-url>

# 删除
shortener-cli delete <code>

# 服务器配置（config.toml 可选；不提供时纯环境变量启动，env 优先于文件）
vim config.toml

# 纯环境变量最小配置
export SERVER__API_KEY="$(openssl rand -base64 32)"
export ADMIN__PASSWORD_HASH='$argon2id$...'   # shortener-server hash-password --password "..."
export DATABASE__URL="sqlite://data/shortener.db?mode=rwc"
export JWT_SECRET="$(openssl rand -base64 48)"

# CLI 配置
shortener-cli init
vim ~/.config/shortener/config.toml

# 登录
curl -X POST http://localhost:8080/api/account/login \
  -H "Content-Type: application/json" \
  -d '{"username":"admin","password":"password"}'

# 创建短链接
curl -X POST http://localhost:8080/api/shortens \
  -H "X-API-KEY: your-api-key" \
  -H "Content-Type: application/json" \
  -d '{"original_url":"https://example.com"}'

# 获取短链接
curl http://localhost:8080/api/shortens/<code> \
  -H "X-API-KEY: your-api-key"

# 刷新缓存（清空前缀旧键并从数据库重载）
curl -X POST http://localhost:8080/api/cache/refresh \
  -H "X-API-KEY: your-api-key"

# 生成 API 密钥
openssl rand -base64 32

# 安全审计
cargo audit

# 基准测试
cargo bench

# 性能分析
cargo build --release
time ./target/release/shortener-server

# Systemd
cd deploy/systemd
sudo ./install.sh
sudo systemctl start shortener-server

# Docker
docker compose -f docker/docker-compose.yml up -d

# 交叉编译
./scripts/build-cross.sh --all

# Fork 并克隆
git clone https://github.com/你的用户名/shortener.git

# 创建分支
git checkout -b feature/your-feature

# 提交更改
git commit -m "添加：your feature"

# 推送
git push origin feature/your-feature