nocfo

分类: 工具与效率 | 上传者: nocfo | 下载: 0 | 版本: v1.0（最新）

Use NoCFO CLI for bookkeeping, invoicing, reporting, and schema introspection. Use when the user wants to query or update NoCFO data from an agent through terminal commands.

更新日志: Source: GitHub https://github.com/nocfo/nocfo-ai-toolkit

目录结构

当前层级: 根目录

📁 .github/
- 📁 workflows/
  - 📄 ci.yaml 762 B
  - 📄 deploy.yaml 1.7 KB
  - 📄 release.yaml 3.2 KB
📁 assets/
- 📄 banner.png 134.7 KB
- 📄 banner.svg 1015.1 KB
📁 scripts/
- 📄 build-and-push-to-ecr.sh 1.0 KB
- 📄 deploy.py 1.9 KB
- 📄 deploy_requirements.txt 12 B
- 📄 generate_cli_commands.py 2.5 KB
- 📄 release-publish.sh 711 B
📁 src/
- 📁 nocfo_toolkit/
  - 📁 cli/
    
    📁 commands/
    
    📄 __init__.py 26 B
    
    📄 _helpers.py 6.1 KB
    
    📄 accounts.py 2.9 KB
    
    📄 auth.py 1.5 KB
    
    📄 businesses.py 2.5 KB
    
    📄 contacts.py 2.9 KB
    
    📄 documents.py 2.9 KB
    
    📄 files.py 2.4 KB
    
    📄 invoices.py 4.5 KB
    
    📄 products.py 2.9 KB
    
    📄 purchase_invoices.py 2.5 KB
    
    📄 reports.py 7.4 KB
    
    📄 schema.py 3.0 KB
    
    📄 tags.py 2.8 KB
    
    📄 user.py 424 B
    
    📄 __init__.py 19 B
    
    📄 app.py 4.8 KB
    
    📄 context.py 1.3 KB
    
    📄 output.py 2.7 KB
  - 📁 mcp/
    
    📄 __init__.py 26 B
    
    📄 auth.py 14.7 KB
    
    📄 server.py 4.4 KB
  - 📄 __init__.py 267 B
  - 📄 api_client.py 4.2 KB
  - 📄 config.py 4.5 KB
  - 📄 openapi.py 2.4 KB
📁 tests/
- 📄 __init__.py 34 B
- 📄 test_cli.py 1.3 KB
- 📄 test_config.py 2.0 KB
- 📄 test_mcp_auth.py 4.5 KB
- 📄 test_mcp_server.py 1.1 KB
- 📄 test_openapi.py 2.4 KB
📄 .dockerignore 115 B
📄 .env.example 83 B
📄 .gitignore 125 B
📄 .pre-commit-config.yaml 540 B
📄 Dockerfile 442 B
📄 LICENSE 1.0 KB
📄 MCP_AUTHENTICATION.md 2.7 KB
📄 package-lock.json 201.4 KB
📄 package.json 794 B
📄 poetry.lock 166.9 KB
📄 pyproject.toml 841 B
📄 README.md 6.7 KB
📄 SKILL.md 3.7 KB

SKILL.md

---
name: nocfo
description: Use NoCFO CLI for bookkeeping, invoicing, reporting, and schema introspection. Use when the user wants to query or update NoCFO data from an agent through terminal commands.
---

# NoCFO CLI Skill

## Purpose

This skill helps an agent use the `nocfo` terminal client efficiently and safely for NoCFO API operations.

## Prerequisites

1. Install CLI:
   - `pip install nocfo-cli`
2. Configure authentication:
   - `nocfo auth configure --token <token>`
3. Verify:
   - `nocfo auth status`

Environment variables:

- `NOCFO_API_TOKEN`
- `NOCFO_BASE_URL` (default `https://api-prd.nocfo.io`)
- `NOCFO_OUTPUT_FORMAT` (`table` or `json`)

## Agent Operating Defaults

Use these defaults unless the user asks otherwise:

1. Always prefer machine-readable output:
   - `--output json`
2. For mutating operations, run dry-run first:
   - `--dry-run`
3. Prefer raw JSON payloads for complex input:
   - `--json-body '{"...": "..."}'`
4. Use schema introspection before uncertain writes:
   - `nocfo schema list`
   - `nocfo schema show <query>`

## Command Structure

Pattern:

- `nocfo <group> <action> [options]`
- Global options: `--output`, `--env-file`, `--base-url`, `--api-token`, `--dry-run`

Main groups:

- `auth`
- `businesses`
- `accounts`
- `documents`
- `contacts`
- `invoices`
- `purchase-invoices`
- `products`
- `files`
- `tags`
- `user`
- `reports`
- `schema`

## Common Workflows

### 1) Check current user and businesses

```bash
nocfo user me
nocfo businesses list
```

### 2) List invoices for a business

```bash
nocfo invoices list --business my-business --query status=PAID
```

### 3) Create or update resources

Use either repeated `--field` pairs or `--json-body`.

```bash
nocfo contacts create --business my-business --field name=Example --field is_invoicing_enabled=true
nocfo products update 123 --business my-business --field name=UpdatedName --partial
```

Agent-safe mutation pattern:

```bash
nocfo --output json --dry-run products update 123 --business my-business --json-body '{"name":"UpdatedName"}' --partial
nocfo --output json products update 123 --business my-business --json-body '{"name":"UpdatedName"}' --partial
```

### 4) Document and account operations

```bash
nocfo documents list --business my-business --query date_from=2026-01-01
nocfo accounts get 1910 --business my-business
```

### 5) File upload

```bash
nocfo files upload ./invoice.pdf --business my-business
```

### 6) Accounting reports (JSON)

```bash
nocfo reports balance-sheet --business my-business --date-at 2026-12-31 --extend-accounts
nocfo reports balance-sheet-short --business my-business --date-at 2026-12-31 --extend-accounts
nocfo reports income-statement --business my-business --date-from 2026-01-01 --date-to 2026-12-31
nocfo reports income-statement-short --business my-business --date-from 2026-01-01 --date-to 2026-12-31
nocfo reports ledger --business my-business --date-from 2026-01-01 --date-to 2026-01-31
nocfo reports journal --business my-business --date-from 2026-01-01 --date-to 2026-01-31
nocfo reports vat --business my-business --date-from 2026-01-01 --date-to 2026-01-31
nocfo reports equity-changes --business my-business --date-at 2026-12-31
```

### 7) Schema introspection

```bash
nocfo schema list
nocfo schema list --all
nocfo schema show report/json
nocfo schema show "Reports - Generate JSON Report"
```

## Error Handling

- If command fails with auth errors, run `nocfo auth status` and refresh token.
- If endpoint or payload fails, retry with `--output json` to inspect exact response.
- Prefer idempotent reads first (`list`, `get`) before writes (`create`, `update`, `delete`).
- If payload validation fails, switch from `--field` pairs to `--json-body`.
- If write shape is unclear, inspect with `nocfo schema show <query>` before retrying.

登录后下载/点赞/收藏 ❤ 2 | ★ 0

nocfo

目录结构

SKILL.md

举报内容

提示