Skip to content

Commit ea66af1

Browse files
Conn-Hoclaude
andcommitted
docs: @okdata/sdk and okdata are on npm
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
1 parent da6f8ca commit ea66af1

5 files changed

Lines changed: 16 additions & 4 deletions

File tree

‎README.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18,9 +18,9 @@ generated from the same catalog the API runs on.
1818

1919
| | Install or connect | Source |
2020
|---|---|---|
21-
| TypeScript SDK | `npm install @okdata/sdk` (on npm within days; until then `npm ci && npm run build` in [`typescript/`](typescript/)) | [`typescript/`](typescript/) |
21+
| TypeScript SDK | [`npm install @okdata/sdk`](https://www.npmjs.com/package/@okdata/sdk) | [`typescript/`](typescript/) |
2222
| Python SDK | `pip install okdata` ([on PyPI](https://pypi.org/project/okdata/)) | [`python/`](python/) |
23-
| Command line | `npx okdata` (on npm within days; until then build [`cli/`](cli/)) | [`cli/`](cli/) |
23+
| Command line | [`npx okdata`](https://www.npmjs.com/package/okdata) | [`cli/`](cli/) |
2424
| Remote MCP server | `https://api.okdata.online/mcp` (Streamable HTTP) | hosted |
2525
| Agent Skills | `npx skills add okdataapi/skills` | [okdataapi/skills](https://github.com/okdataapi/skills) |
2626
| Plain HTTP | `https://api.okdata.online/v1/...` | [`docs/openapi.json`](docs/openapi.json) |
@@ -205,9 +205,9 @@ OpenAPI 3.1、价目表)。这些都由 API 自己用的同一份接口目录
205205

206206
| | 安装或接入 | 源码 |
207207
|---|---|---|
208-
| TypeScript SDK | `npm install @okdata/sdk`(这几天发布到 npm,之前可在 [`typescript/`](typescript/) 里 `npm ci && npm run build`) | [`typescript/`](typescript/) |
208+
| TypeScript SDK | [`npm install @okdata/sdk`](https://www.npmjs.com/package/@okdata/sdk) | [`typescript/`](typescript/) |
209209
| Python SDK | `pip install okdata`([已在 PyPI](https://pypi.org/project/okdata/)) | [`python/`](python/) |
210-
| 命令行 | `npx okdata`(这几天发布到 npm,之前可自行构建 [`cli/`](cli/)) | [`cli/`](cli/) |
210+
| 命令行 | [`npx okdata`](https://www.npmjs.com/package/okdata) | [`cli/`](cli/) |
211211
| 远程 MCP | `https://api.okdata.online/mcp`(Streamable HTTP) | 托管 |
212212
| Agent Skills | `npx skills add okdataapi/skills` | [okdataapi/skills](https://github.com/okdataapi/skills) |
213213

‎cli/package.json‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,10 @@
1010
"engines": {
1111
"node": ">=20.3"
1212
},
13+
"publishConfig": {
14+
"access": "public",
15+
"registry": "https://registry.npmjs.org/"
16+
},
1317
"scripts": {
1418
"build": "node -e \"require('node:fs').rmSync('dist',{recursive:true,force:true})\" && tsc -p tsconfig.build.json",
1519
"typecheck": "tsc --noEmit",

‎docs/llms.txt‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,8 @@ Each is a few calls laid out as one table, with a SKILL.md an agent can install
4545
- [Set it up in an agent](https://okdata.online/agents.md)
4646
- [Errors](https://okdata.online/docs/errors.md)
4747
- [MCP](https://okdata.online/mcp.md): the tools and every client
48+
- [SDKs](https://okdata.online/docs/sdk.md): `pip install okdata`, `npm install @okdata/sdk`
49+
- [Command line](https://okdata.online/docs/cli.md): `npx okdata`: find, call, log in, set up MCP
4850

4951
## Endpoints by platform
5052

‎docs/zh/llms.txt‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,8 @@
4545
- [在智能体里接入](https://okdata.online/zh/agents.md)
4646
- [错误码](https://okdata.online/zh/docs/errors.md)
4747
- [MCP](https://okdata.online/zh/mcp.md): 工具和各客户端接法
48+
- [SDK](https://okdata.online/zh/docs/sdk.md): `pip install okdata`、`npm install @okdata/sdk`
49+
- [命令行](https://okdata.online/zh/docs/cli.md): `npx okdata`:找接口、调用、登录、配置 MCP
4850

4951
## 各平台接口
5052

‎typescript/package.json‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,10 @@
1717
"engines": {
1818
"node": ">=20.3"
1919
},
20+
"publishConfig": {
21+
"access": "public",
22+
"registry": "https://registry.npmjs.org/"
23+
},
2024
"scripts": {
2125
"build": "node -e \"require('node:fs').rmSync('dist',{recursive:true,force:true})\" && tsc -p tsconfig.build.json",
2226
"typecheck": "tsc --noEmit && tsc -p tsconfig.build.json --noEmit",

0 commit comments

Comments
 (0)