tuyaopen-embedded-project

Files (3)

• SKILL.md
• CONFIG_CLI.md · references/
• TOS_COMMANDS.md · references/

SKILL.md (first lines)

# TuyaOpen Project, Demos & Config

> **SDK root:** `tos.py`-side paths and commands in this skill are relative to the TuyaOpen SDK root (`$OPEN_SDK_ROOT` on Linux/macOS/PowerShell, `%OPEN_SDK_ROOT%` on Windows CMD). Activate the environment first — see the `tuyaopen-start` routing table. The `tuyaopen-cli project` / `demos` / `config` CLI commands below don't need SDK-env activation — they read/write `.tuyaopen/` and IDE settings directly.

Docs: <https://tuyaopen.ai/docs/tos-tools/tos-guide>

## Shortcuts — `tuyaopen-cli project` / `tuyaopen-cli config` / `tuyaopen-cli demos` / `tuyaopen-cli manifests`

| Intent | Command |
|---|---|
| Read the `.tuyaopen/` project descriptor | `tuyaopen-cli project info` |
| Create a project non-interactively | `tuyaopen-cli project create` (P2) |
| Set platform / board / lifecycle status / AI intent | `tuyaopen-cli project set-platform` · `set-board` · `set-status` · `set-intent` (all P2) |
| Bind a product PID to this project | `tuyaopen-cli project bind-product` (P2) |
| Read / write IDE settings (`language`/`gitMirror`/`manifestsSource` — **not** Kconfig, see the warning below) | `tuyaopen-cli config get` · `config list` · `config set` (P2) |
| Browse the local demo/example catalogue | `tuyaopen-cli demos list` · `demos detail` |
| Local manifest cache status / sync | `tuyaopen-cli manifests status` · `manifests sync` (P2) |

Flags aren't listed here — run `tuyaopen-cli schema get --group <g> --command <c>`
for the current set. Resolve `tuyaopen-cli` first per skill `tuyaopen-start` § 1
(it is usually not on `PATH`).

> **No CLI?** `project create` → `tos.py new project` (interactive; see
> § *Creating a New Project* below). No older-tool equivalent for the rest
> of this table — see skill `tuyaopen-start` § 7.

## ⚠ Two commands named `config` — read this before touching either

`tos.py config` and `tuyaopen-cli config` are **two unrelated commands that
happen to share a word**, and guessing wrong silently no-ops instead of
erroring loudly:

| | Edits | Keys |
|---|---|---|
| `tos.py config` (`choice`/`menu`/`save`/`set`/`get`/`list`/`diff`) | The project's **Kconfig build configuration** — `app_default.config`, `.build/cache/using.config` | Hundreds of `CONFIG_*` Kconfig symbols — see § *Configuration Management* below |
| `tuyaopen-cli config` (`get`/`set`/`list`) | **IDE settings** — nothing to do with Kconfig | Exactly three: `language`, `gitMirror`, `manifestsSource` (verified against `ALLOWED_CONFIG_KEYS` in the IDE's `src/cli/cliConfig.ts`) |

The intuitive guess for "set a build config option" is `tuyaopen-cli config
set` — that is the **wrong** command: it will reject any Kconfig-style key
since it isn't one of the three IDE settings, and do nothing to the project.
Use `tos.py config set` (§ *Configuration Management*) for Kconfig. This same
trap is called out once already in skill `tuyaopen-start` § 7 — it's worth
repeating here because this is the skill someone lands on when they type
"config" for either intent.

## `tuyaopen-cli config` — IDE settings

```bash
tuyaopen-cli config list                          # all three keys (empty object = all defaults)
tuyaopen-cli config get --key language
tuyaopen-cli config set --key gitMirror --value <value>   # P2 — needs --yes, or --dry-run
```

Flags: `tuyaopen-cli config --help` / `tuyaopen-cli schema get --group config
--command set`. `set` is mutating (P2, see skill `tuyaopen-start` § 4);
`get`/`list` are read-only.

## `tuyaopen-cli project` — read/write the `.tuyaopen/` descriptor

Seven subcommands over the `.tuyaopen/` layout described in skill
`tuyaopen-start` § 8:

| Subcommand | Purpose | Risk |
|---|---|---|
| `info` | Show identity + lifecycle + bound product/board (read-only) | — |
| `create` | Scaffold a new project, optionally from a manifest demo/board | P2 |
| `set-platform` | Set `[platform] target` in `tuyaopen.project.ini` | P2 |
| `set-board` | Set `[board] id` (+ optional `kconfig_id`) | P2 |
| `set-status` | Advance the lifecycle (`scaffolded`/`configured`/`built`/`flashed`) in `.tuyaopen/status.json` | P2 |
| `set-intent` | Record the AI intent text into `.tuyaopen/project.json` | P2 |
| `bind-product` | Bind a Tuya product PID (writes `[product] pid`) | P2 |

```bash
tuyaopen-cli project info --json
tuyaopen-cli project create --name my-app --demo peripherals-led --board tuya-t5-e1
tuyaopen-cli project bind-product --pid <pid>
```

`create` needs either `--extension-path` (IDE-injected media templates) or
`--sdk-root` (SDK's own `tools/app_template/`); an SDK-subpath demo (most of
them) additionally needs the SDK installed. Full flags: `tuyaopen-cli project
--help` / `tuyaopen-cli schema get --group project --command create` — don't
memorize the flag list, it evolves under the CLI's own contract snapshot (see
skill `tuyaopen-start` § 5).

This is the CLI-first equivalent of `tos.py new project` (see § *Creating a
New Project* below for the interactive/manual path, still needed for TTY
scaffolding or when neither `--extension-path` nor `--sdk-root` is
available).

## `tuyaopen-cli demos` — browse the local manifest catalogue

Read-only queries against the same local manifest cache `project create
--demo`/`--board` reads from — no network, no cloud:

```bash
tuyaopen-cli demos list --json                    # id, name, type, summary, compatibility
tuyaopen-cli demos detail --id peripherals-led --json    # source, build configs, cloud/PID spec
```

Needs a synced local manifests cache (`tuyaopen-cli manifests sync`) or
`TUYAOPEN_MANIFESTS_PATH` pointed at one — otherwise both return
`config:no_manifest_cache`.

## Creating a New Project

> All `tos.py new` subcommands are **interactive** (use `input()` / menu prompts). They require a TTY and cannot be used in non-interactive Agent/CI pipelines.

### `tos.py new project` (interactive)

Creates a new application from a template **in the current working directory**.

```bash
cd apps/my_category          # navigate to where you want the project
tos.py new project               # defaults to base framework
tos.py new project --framework arduino   # Arduino-style project
```

Flow:
1. Prompts for project name (e.g. `my_app`).

From tuya/tuyaopen-ide-manifests, Apache-2.0.

More from tuya/tuyaopen-ide-manifests