ignis

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

Ignis

Ignis

在当前任务是“使用 Ignis 开发或发布 service”时使用这个 skill,而不是修改 Ignis 仓库本身时使用。
适用范围:
  • 使用
    ignis-cli
    初始化、构建、发布和部署 service
  • 使用
    ignis-sdk
    的 HTTP Router、中间件、响应 helper、SQLite 和 migration
  • 编写或排查
    ignis.toml
  • 使用 examples 里的最小项目结构快速起步
不适用范围:
  • ignis_login
    / Hosted Login / PKCE / provider 配置细节 这些走
    ignis-login
  • 修改
    ignis-cli
    ignis-sdk
    ignis-manifest
    ignis-runtime
    ignis-platform-host
    源码
  • 维护仓库 docs、skills 或生成文档
Use this skill when the current task is "developing or publishing services with Ignis", not when modifying the Ignis repository itself.
Scope of application:
  • Use
    ignis-cli
    to initialize, build, publish and deploy services
  • Use HTTP Router, middleware, response helper, SQLite and migration from
    ignis-sdk
  • Write or troubleshoot
    ignis.toml
  • Quickly get started with the minimal project structure in examples
Scope of inapplicability:
  • ignis_login
    / Hosted Login / PKCE / provider configuration details These are handled by
    ignis-login
  • Modify source code of
    ignis-cli
    ,
    ignis-sdk
    ,
    ignis-manifest
    ,
    ignis-runtime
    ,
    ignis-platform-host
  • Maintain repository docs, skills or generate documentation

快速流程

Quick Process

  1. 先读
    references/integration.md
    ,确认完整接入路径。
  2. 如果任务偏 CLI 或发布部署,继续读
    references/cli.md
  3. 如果任务偏
    ignis.toml
    字段、默认值或示例配置,读
    references/ignis-toml.md
  4. 如果任务偏
    ignis-sdk
    API,用
    references/ignis-sdk/index.md
    作为入口,只继续打开当前需要的模块或 item 页面。
  5. 如果任务涉及登录或
    [services.ignis_login]
    ,切到
    ignis-login
    skill。
  6. 如果需要最小 HTTP / SQLite 模板,优先读整个 example 项目:
    references/examples/hello-fullstack/
    references/examples/sqlite-example/
  1. First read
    references/integration.md
    to confirm the complete integration path.
  2. If the task focuses on CLI or release deployment, continue reading
    references/cli.md
    .
  3. If the task focuses on
    ignis.toml
    fields, default values or sample configurations, read
    references/ignis-toml.md
    .
  4. If the task focuses on
    ignis-sdk
    API, use
    references/ignis-sdk/index.md
    as the entry point, and only open the currently required module or item page further.
  5. If the task involves login or
    [services.ignis_login]
    , switch to the
    ignis-login
    skill.
  6. If you need minimal HTTP / SQLite templates, prioritize reading the entire example projects:
    references/examples/hello-fullstack/
    and
    references/examples/sqlite-example/
    .

工作规则

Working Rules

  • ignis.toml
    文档和
    ignis-sdk
    生成文档当作配置/API 的事实来源。
  • 不要猜测
    ignis.toml
    字段、CLI 命令名、
    ignis-sdk
    方法或 secret 约定。
  • 当前推荐工作流是:
    ignis login -> ignis project create -> ignis service new -> ignis service build -> ignis service publish -> ignis service deploy
  • 当前 CLI 不再把本地
    dev
    作为主工作流;默认以构建、发布、部署为准。
  • 简单 handler 可以直接用
    wstd::http
    ,但多路由、中间件、统一响应、SQLite 通常优先用
    ignis-sdk
  • 需要查 SDK 细节时,优先读
    mddoc
    生成的单页,不要只靠摘要文档推断。
  • 当前公网路由模型是一个 project host 下按 path prefix 暴露 services,例如前端走
    /
    ,API 走
    /api
    ,不要再假设
    api.<project-host>
    这类子域。
  • 当前
    http
    service 统一使用标准
    wasm32-wasip2
    构建路径,不要再按
    cargo-component
    工作流推断 CLI 行为。
  • ignis-sdk
    依赖来源不要猜测;如果当前版本未发布到 crates.io,使用明确的
    path
    或固定
    git
    版本。
  • Treat
    ignis.toml
    documentation and
    ignis-sdk
    generated documentation as the source of truth for configuration/API.
  • Do not guess
    ignis.toml
    fields, CLI command names,
    ignis-sdk
    methods or secret conventions.
  • The currently recommended workflow is:
    ignis login -> ignis project create -> ignis service new -> ignis service build -> ignis service publish -> ignis service deploy
    .
  • The current CLI no longer takes local
    dev
    as the main workflow; build, publish and deployment are the default priorities.
  • Simple handlers can directly use
    wstd::http
    , but
    ignis-sdk
    is usually preferred for multi-routing, middleware, unified responses, and SQLite.
  • When you need to check SDK details, prioritize reading the single page generated by
    mddoc
    , do not infer only from summary documents.
  • The current public network routing model exposes services by path prefix under a project host, for example, the frontend uses
    /
    and the API uses
    /api
    , do not assume subdomains like
    api.<project-host>
    anymore.
  • The current
    http
    service uniformly uses the standard
    wasm32-wasip2
    build path, do not infer CLI behavior according to the
    cargo-component
    workflow anymore.
  • Do not guess the source of
    ignis-sdk
    dependencies; if the current version is not published to crates.io, use an explicit
    path
    or fixed
    git
    version.

参考资料

References

  • 接入流程:
    references/integration.md
  • CLI:
    references/cli.md
  • ignis.toml
    references/ignis-toml.md
  • ignis-sdk
    生成文档入口:
    references/ignis-sdk/index.md
  • 最小 HTTP 示例项目:
    references/examples/hello-fullstack/
  • SQLite 示例项目:
    references/examples/sqlite-example/
  • 文档索引:
    references/doc_index.md
  • Integration process:
    references/integration.md
  • CLI:
    references/cli.md
  • ignis.toml
    :
    references/ignis-toml.md
  • ignis-sdk
    generated documentation entry:
    references/ignis-sdk/index.md
  • Minimal HTTP example project:
    references/examples/hello-fullstack/
  • SQLite example project:
    references/examples/sqlite-example/
  • Documentation index:
    references/doc_index.md