houseassassin/twenty
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

i18n - docs translations (#19128)

Browse Source 
Created by Github action

Co-authored-by: github-actions <github-actions@twenty.com>
This commit is contained in:
github-actions[bot]
2026-03-30 16:49:57 +02:00
committed by GitHub
parent 6c128a35dd
commit 40abe1e6d0
16 changed files with 513 additions and 513 deletions
Download Patch File Download Diff File Expand all files Collapse all files
packages/twenty-docs/l/zh/developers/extend/apps/getting-started.mdx
+3 -3
View File
@@ -123,7 +123,7 @@ my-twenty-app/
总体来说：
* **package.json**：声明应用名称、版本、引擎（Node 24+、Yarn 4），并添加 `twenty-sdk` 以及一个 `twenty` 脚本，该脚本会委托给本地的 `twenty` CLI。 运行 `yarn twenty help` 以列出所有可用命令。
* **.gitignore**: Ignores common artifacts such as `node_modules`, `.yarn`, `.twenty/`, `dist/`, `build/`, coverage folders, log files, and `.env*` files.
* **.gitignore**：忽略常见产物，如 `node_modules`、`.yarn`、`.twenty/`、`dist/`、`build/`、覆盖率文件夹、日志文件以及 `.env*` 文件。
* **yarn.lock**、**.yarnrc.yml**、**.yarn/**：锁定并配置项目使用的 Yarn 4 工具链。
* **.nvmrc**：固定项目期望的 Node.js 版本。
* **.oxlintrc.json** 和 **tsconfig.json**：为应用的 TypeScript 源码提供 Lint 与 TypeScript 配置。
@@ -167,8 +167,8 @@ export default defineObject({
后续命令将添加更多文件和文件夹：
* `yarn twenty dev` will auto-generate the typed `CoreApiClient` (for workspace data via `/graphql`) into `node_modules/twenty-client-sdk/`. The `MetadataApiClient` (for workspace configuration and file uploads via `/metadata`) ships pre-built and is available immediately. Import them from `twenty-client-sdk/core` and `twenty-client-sdk/metadata` respectively.
* `yarn twenty add` will add entity definition files under `src/` for your custom objects, functions, front components, roles, skills, and more.
* `yarn twenty dev` 会自动生成类型化的 `CoreApiClient`（通过 `/graphql` 获取工作区数据），并写入 `node_modules/twenty-client-sdk/`。 `MetadataApiClient`（通过 `/metadata` 处理工作区配置和文件上传）为预构建版本，可立即使用。 分别从 `twenty-client-sdk/core` 和 `twenty-client-sdk/metadata` 导入它们。
* `yarn twenty add` 会在 `src/` 下为你的自定义对象、函数、前端组件、角色、技能等添加实体定义文件。
## 身份验证
packages/twenty-docs/l/zh/developers/extend/apps/publishing.mdx
+62 -62
View File
@@ -24,9 +24,9 @@ description: 将你的 Twenty 应用分发到应用市场，或进行内部部
yarn twenty build
```
输出将写入 `.twenty/output/`。 This directory contains everything needed for distribution: compiled code, assets, the manifest, and a copy of your `package.json`.
输出将写入 `.twenty/output/`。 此目录包含分发所需的一切：已编译的代码、资源、清单，以及你的 `package.json` 副本。
To also create a `.tgz` tarball (used by the deploy command internally, or for manual distribution):
要同时创建一个 `.tgz` 压缩包（由部署命令在内部使用，或用于手动分发）：
```bash filename="Terminal"
yarn twenty build --tarball
@@ -39,11 +39,11 @@ yarn twenty build --tarball
### 要求
* 一个 [npm](https://www.npmjs.com) 账户
* The `twenty-app` keyword **must** be listed in your `package.json` `keywords` array
* 在你的 `package.json` 的 `keywords` 数组中**必须**包含 `twenty-app` 关键字
### Adding the required keyword
### 添加所需关键字
The Twenty marketplace discovers apps by searching the npm registry for packages with the `twenty-app` keyword. Add it to your `package.json`:
Twenty 市场通过在 npm 注册表中搜索带有 `twenty-app` 关键字的包来发现应用。 将其添加到你的 `package.json`：
```json filename="package.json"
{
@@ -55,56 +55,56 @@ The Twenty marketplace discovers apps by searching the npm registry for packages
```
<Note>
The marketplace searches for `keywords:twenty-app` on the npm registry. Without this keyword, your package won't appear in the marketplace even if it has the `twenty-app-` name prefix.
该市场会在 npm 注册表中搜索 `keywords:twenty-app`。 没有此关键字，即使包名带有 `twenty-app-` 前缀，你的包也不会出现在市场中。
</Note>
### 步骤
1. **Build your app:**
1. **构建你的应用：**
```bash filename="Terminal"
yarn twenty build
```
2. **Publish to npm:**
2. **发布到 npm：**
```bash filename="Terminal"
yarn twenty publish
```
This runs `npm publish` from the `.twenty/output/` directory.
这会在 `.twenty/output/` 目录下运行 `npm publish`。
To publish under a specific dist-tag (e.g., `beta` or `next`):
要在特定的 dist-tag（例如 `beta` 或 `next`）下发布：
```bash filename="Terminal"
yarn twenty publish --tag beta
```
### How marketplace discovery works
### 应用市场的发现机制如何运作
The Twenty server syncs its marketplace catalog from the npm registry **every hour**:
Twenty 服务器会**每小时**从 npm 注册表同步其市场目录：
1. It searches for all npm packages with the `keywords:twenty-app` keyword
2. For each package, it fetches the `manifest.json` from the npm CDN
3. The app's metadata (name, description, author, logo, screenshots, category) is extracted from the manifest and displayed in the marketplace
1. 它会搜索所有带有 `keywords:twenty-app` 关键字的 npm 包
2. 对于每个包，它会从 npm CDN 获取 `manifest.json`
3. 应用的元数据（名称、描述、作者、徽标、屏幕截图、类别）将从清单中提取，并显示在市场中
After publishing, your app can take up to one hour to appear in the marketplace. To trigger the sync immediately instead of waiting for the next hourly run:
发布后，你的应用最多可能需要一小时才会出现在市场中。 要立即触发同步，而无需等待下一次每小时同步：
```bash filename="Terminal"
yarn twenty catalog-sync
```
To target a specific remote:
要指定特定的远程：
```bash filename="Terminal"
yarn twenty catalog-sync -r production
```
The metadata shown in the marketplace comes from your `defineApplication()` call in your app source code — fields like `displayName`, `description`, `author`, `category`, `logoUrl`, `screenshots`, `aboutDescription`, `websiteUrl`, and `termsUrl`.
市场中显示的元数据来自你在应用源代码中调用的 `defineApplication()` —— 诸如 `displayName`、`description`、`author`、`category`、`logoUrl`、`screenshots`、`aboutDescription`、`websiteUrl` 和 `termsUrl` 等字段。
### CI 发布
The scaffolded project includes a GitHub Actions workflow that publishes on every release:
脚手架项目包含一个 GitHub Actions 工作流，会在每次发版时自动发布：
```yaml filename=".github/workflows/publish.yml"
name: Publish
@@ -133,39 +133,39 @@ jobs:
NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
```
For other CI systems (GitLab CI, CircleCI, etc.), the same three commands apply: `yarn install`, `yarn twenty build`, then `npm publish` from `.twenty/output`.
对于其他 CI 系统（GitLab CI、CircleCI 等），同样适用以下三条命令：`yarn install`、`yarn twenty build`，然后在 `.twenty/output` 目录下执行 `npm publish`。
<Tip>
**npm provenance** 可选，但建议启用。 使用 `--provenance` 发布会在你的 npm 列表中添加可信徽章，使用户可以验证该包是由公共 CI 流水线中的特定提交构建的。 有关设置说明，请参见 [npm provenance 文档](https://docs.npmjs.com/generating-provenance-statements)。
</Tip>
## Deploying to a server (tarball)
## 部署到服务器（tar 包）
For apps you don't want publicly available — proprietary tools, enterprise-only integrations, or experimental builds — you can deploy a tarball directly to a Twenty server.
对于你不希望公开的应用（专有工具、仅供企业使用的集成或实验性构建），你可以将 tar 包直接部署到某台 Twenty 服务器。
### 先决条件
Before deploying, you need a configured remote pointing to the target server. Remotes store the server URL and authentication credentials locally in `~/.twenty/config.json`.
在部署之前，你需要配置一个指向目标服务器的远程。 远程会将服务器 URL 和身份验证凭据本地存储在 `~/.twenty/config.json` 中。
Add a remote:
添加远程：
```bash filename="Terminal"
yarn twenty remote add --url https://your-twenty-server.com --as production
```
For a local development server:
对于本地开发服务器：
```bash filename="Terminal"
yarn twenty remote add --local --as local
```
You can also authenticate with an API key for non-interactive environments:
对于非交互式环境，你也可以使用 API 密钥进行身份验证：
```bash filename="Terminal"
yarn twenty remote add --url https://your-twenty-server.com --token <api-key> --as production
```
Manage your remotes:
管理你的远程：
```bash filename="Terminal"
yarn twenty remote list # List all configured remotes
@@ -174,76 +174,76 @@ yarn twenty remote status # Show active remote and auth status
yarn twenty remote remove old # Remove a remote
```
### Deploying
### 部署
Build and upload your app to the server in one step:
一步构建并将你的应用上传到服务器：
```bash filename="Terminal"
yarn twenty deploy
```
This builds the app with `--tarball`, then uploads the tarball to the default remote via a GraphQL multipart upload.
这会使用 `--tarball` 构建应用，然后通过 GraphQL 多部分上传将该 tar 包上传到默认远程。
To deploy to a specific remote:
部署到特定远程：
```bash filename="Terminal"
yarn twenty deploy -r production
```
### Sharing a deployed app
### 共享已部署的应用
Tarball apps are not listed in the public marketplace, so other workspaces on the same server won't discover them by browsing. To share a deployed app:
通过 tar 包分发的应用不会出现在公共市场中，因此同一服务器上的其他工作区无法通过浏览发现它们。 要共享已部署的应用：
1. Go to **Settings > Applications > Registrations** and open your app
2. In the **Distribution** tab, click **Copy share link**
3. Share this link with users on other workspaces — it takes them directly to the app's install page
1. 前往 **Settings > Applications > Registrations** 并打开你的应用
2. 在 **Distribution** 选项卡中，点击 **Copy share link**
3. 将此链接分享给其他工作区的用户 — 它会将他们直接带到该应用的安装页面
The share link uses the server's base URL (without any workspace subdomain) so it works for any workspace on the server.
该分享链接使用服务器的基础 URL（不包含任何工作区子域），因此适用于该服务器上的任意工作区。
### 版本管理
要发布更新：
1. 更新 `package.json` 中的 `version` 字段
2. Run `yarn twenty deploy` (or `yarn twenty deploy -r production`)
3. Workspaces that have the app installed will see the upgrade available in their settings
2. 运行 `yarn twenty deploy`（或 `yarn twenty deploy -r production`）
3. 已安装该应用的工作区会在其设置中看到可用的升级
## Installing apps
## 安装应用
Once an app is published (npm) or deployed (tarball), workspaces install it through the UI:
一旦应用已发布（npm）或已部署（tar 包），各工作区即可通过 UI 进行安装：
```bash filename="Terminal"
yarn twenty install
```
Or from the **Settings > Applications** page in the Twenty UI, where both marketplace and tarball-deployed apps can be browsed and installed.
或者在 Twenty UI 的 **Settings > Applications** 页面中浏览并安装来自市场或通过 tar 包部署的应用。
## App distribution categories
## 应用分发类别
Twenty 会根据分发方式将应用归为三类：
| 类别 | 工作原理 | 在应用市场中可见？ |
| ---------------------- | ---------------------------------------------------------------------------------- | --------- |
| **开发** | 通过 `yarn twenty dev` 运行的本地开发模式应用。 用于构建和测试。 | 否 |
| **Published (npm)** | Apps published to npm with the `twenty-app` keyword. 在应用市场上架，供任何工作区安装。 | 是 |
| **Internal (tarball)** | 通过 tar 包部署到特定服务器的应用。 Available only to workspaces on that server via a share link. | 否 |
| 类别 | 工作原理 | 在应用市场中可见？ |
| ------------- | -------------------------------------------------- | --------- |
| **开发** | 通过 `yarn twenty dev` 运行的本地开发模式应用。 用于构建和测试。 | 否 |
| **已发布（npm）** | 发布到 npm 且包含 `twenty-app` 关键字的应用。 在应用市场上架，供任何工作区安装。 | 是 |
| **内部（tar 包）** | 通过 tar 包部署到特定服务器的应用。 仅通过分享链接对该服务器上的工作区可用。 | 否 |
<Tip>
在构建你的应用时，从**开发**模式开始。 准备就绪后，选择用于广泛分发的**已发布**（npm），或用于私有部署的**内部**（tar 包）。
</Tip>
## CLI reference
## CLI 参考
| 命令 | 描述 | Key flags |
| --------------------------- | ---------------------------------------------- | --------------------------------------------------- |
| `yarn twenty build` | Compile app and generate manifest | `--tarball` — also create a `.tgz` package |
| `yarn twenty publish` | Build and publish to npm | `--tag <tag>` — npm dist-tag (e.g., `beta`, `next`) |
| `yarn twenty deploy` | Build and upload tarball to a server | `-r, --remote <name>` — target remote |
| `yarn twenty catalog-sync` | Trigger marketplace catalog sync on the server | `-r, --remote <name>` — target remote |
| `yarn twenty install` | Install a deployed app on a workspace | `-r, --remote <name>` — target remote |
| `yarn twenty dev` | Watch and sync local changes | Uses default remote |
| `yarn twenty remote add` | Add a server connection | `--url`, `--token`, `--as`, `--local`, `--port` |
| `yarn twenty remote list` | List configured remotes | — |
| `yarn twenty remote switch` | Set default remote | — |
| `yarn twenty remote status` | Show connection status | — |
| `yarn twenty remote remove` | Remove a remote | — |
| 命令 | 描述 | 关键选项 |
| --------------------------- | ---------------- | ------------------------------------------- |
| `yarn twenty build` | 编译应用并生成清单 | `--tarball` — 同时创建一个 `.tgz` 包 |
| `yarn twenty publish` | 构建并发布到 npm | `--tag <tag>` — npm 分发标签（例如 `beta`、`next`） |
| `yarn twenty deploy` | 构建并将 tar 包上传到服务器 | `-r, --remote <name>` — 目标远程 |
| `yarn twenty catalog-sync` | 在服务器上触发市场目录同步 | `-r, --remote <name>` — 目标远程 |
| `yarn twenty install` | 在某个工作区安装已部署的应用 | `-r, --remote <name>` — 目标远程 |
| `yarn twenty dev` | 监听并同步本地更改 | 使用默认远程 |
| `yarn twenty remote add` | 添加服务器连接 | `--url`，`--token`，`--as`，`--local`，`--port` |
| `yarn twenty remote list` | 列出已配置的远程 | — |
| `yarn twenty remote switch` | 设置默认远程 | — |
| `yarn twenty remote status` | 显示连接状态 | — |
| `yarn twenty remote remove` | 移除远程 | — |