smithue-cli

KO | EN

gitlite — search

#cli #chatbot #vue #proxy #hacktoberfest #nodejs #artificial-intelligence #shell #gemini #postgresql

(★ 9)

No description available.

파일 탐색기

ZIP 다운로드

- - release.yml
  - smoke.yml
- - task-10-classify.txt
  - task-11-factory-dryrun.json
  - task-11-name-collision.txt
  - task-12-lint.json
  - task-3-schema-validate.txt
  - task-4-config-validate.txt
  - task-4-upgrade-runs.txt
  - task-9-ownership.txt
- config.md
- factory.md
- lint.md
- RELEASE.md
- spec-format.md
- - sample-assets.json
- - studio.config.json
- - golden-plan.json
- - golden-infer.json
- - bad-name-pattern.invalid.json
  - character.valid.json
  - missing-schema-version.invalid.json
  - prop.valid.json
  - wrong-schema-version.invalid.json
- bp_describe_components.contract.json
- scan_assets.contract.json
- config.schema.json
- spec.schema.json
- postinstall.cjs
- - asset-migration.md
  - asset-slimming.md
  - batch-and-dialogs.md
  - blueprint.md
  - compliance.md
  - material.md
  - parent-class-redirect.md
- - smithue-exec.mjs
  - smithue.ps1
- SKILL.md
- - classifier.test.ts
  - classifier.ts
  - index.ts
  - types.ts
- - batch.ts
  - exec-params.test.ts
  - exec-params.ts
  - exec.ts
  - factory.ts
  - lint.ts
  - list.ts
  - prune.test.ts
  - prune.ts
  - purge.ts
  - search.ts
  - skill.ts
  - spec.ts
  - status.ts
  - upgrade.ts
  - use.ts
- - index.ts
  - ownership.test.ts
  - ownership.ts
  - resolver.test.ts
  - resolver.ts
  - types.ts
- - index.ts
  - planner.test.ts
  - planner.ts
  - types.ts
- - checker.test.ts
  - checker.ts
  - index.ts
  - types.ts
- - index.ts
  - infer.test.ts
  - infer.ts
  - loader.test.ts
  - loader.ts
  - types.ts
- cli.ts
- client.ts
- identity.ts
- output.ts
- portfile.ts
- proc.ts
- registry.ts
- types.ts
- - dryrun.test.ts
- - batch.test.ts
  - client.test.ts
  - exec.test.ts
  - identity.test.ts
  - list.test.ts
  - output.test.ts
  - portfile.test.ts
  - proc.test.ts
  - purge.test.ts
  - registry.test.ts
  - search.test.ts
  - skill.test.ts
  - status.test.ts
  - upgrade.test.ts
  - use.test.ts
.gitignore
CHANGELOG.md
MIGRATION.md
package-lock.json
package.json
README.es-ES.md
README.md
tsconfig.build.json
tsconfig.json
vitest.config.ts

# CDN으로 사용하기

jsDelivr

jsDelivr는 공개 GitHub 리포지토리를 별도 설정 없이 CDN으로 즉시 서빙합니다. 버전과 파일을 고르면 웹페이지에 바로 붙일 수 있는 링크와 예시 코드가 만들어집니다.

버전

파일

링크

예시

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

Stateless command line interface for the SmithUE Unreal Engine plugin.

## For AI Agents

### Quick Deploy
- **Windows**: `npm install -g smithue-cli`
- **macOS**: `npm install -g smithue-cli`
- **Linux**: `npm install -g smithue-cli`

*Note: The v1 plugin server is Windows-only. The CLI npm package installs on any OS, but requires a Windows machine running the UE editor.*

### Prerequisites check
Ensure Node.js 18+ is installed. Run `node -v` to check.

### Verification
Run this command to check if the CLI can find your running Unreal Engine project:
```powershell
smithue-cli status
```

### Fault tree (if things go wrong)
1. **Editor not running**: Start Unreal Engine and verify the SmithUE plugin is active.
2. **Multiple instances**: If you have two editors open, the CLI needs help. Use `smithue-cli status` to see PIDs, then pass `--pid <number>` to your command.
3. **Stale portfile**: If the editor crashed, a `.port` file might remain in `%LOCALAPPDATA%\.smithue\`. Run `smithue-cli prune` to clean up dead files.
4. **Connection refused**: Check if your firewall blocks local port traffic. SmithUE only listens on 127.0.0.1.

## Installation
Standard installation via npm:
```bash
npm install -g smithue-cli
```
Or run directly without installing:
```bash
npx smithue-cli <command>
```

## Subcommands

| Command | Description |
|---|---|
| `exec` | Run a remote command in UE |
| `list` | List available domains or objects |
| `search` | Find assets or objects by string |
| `status` | Show running UE instances and their ports |
| `batch` | Run multiple read-only commands sequentially |
| `upgrade` | Update the CLI to the latest version via npm |
| `prune` | Remove stale port files from crashed instances |
| `purge` | Remove the entire `.smithue` directory (full uninstall cleanup) |
| `use` | Pin (or unpin) a default SmithUE instance for multi-editor setups |
| `skill` | Print or install the bundled SKILL.md for AI agent integration |

## Output Modes

By default, `smithue-cli` outputs pretty-printed JSON (2-space indent).

- `--terse` — Minified JSON (no whitespace). Recommended for AI agents to save tokens.
- `--out <file>` — Write result to file; stdout is silent. Useful for large responses.
- Combined: `smithue-cli status --terse --out result.json`

## Batch Mode

Run multiple read-only commands in a single call:

```bash
smithue-cli batch "status" "list"
```

Returns a JSON array: `[{command, ok, data?, error?}, ...]`

Supported commands: `status`, `list`, `search`. Sequential execution only.

## Upgrading

```bash
smithue-cli upgrade
```

Updates `smithue-cli` to the latest version via npm. A warning is printed to stderr if the CLI version does not match the plugin version.

## AI Agent Integration

Recommended flags for AI agent usage:

```bash
# Minified output saves tokens
smithue-cli status --terse

# Write large responses to file, keep context clean
smithue-cli list --out tools.json

# Multiple queries in one call
smithue-cli batch "status" "list" --terse
```

## Examples
List all Material assets:
```bash
smithue-cli list Material
```

Search for blueprints:
```bash
smithue-cli search blueprint
```

Execute a custom action:
```bash
smithue-cli exec my_action '{"key": "value"}'
```

### Shell-safe parameter passing (recommended for complex JSON)

Positional JSON strings can be mangled by some shells — notably **Windows PowerShell 5.1**, which strips quotes or splits on spaces. Use `--stdin` or `--params-file` for shell- and PowerShell-version-agnostic parameter passing:

```powershell
# --stdin: pipe JSON from a file (safe on all shells and PowerShell versions)
Get-Content params.json -Raw | smithue-cli exec my_action --stdin

# Shorthand: pass "-" as the params argument (equivalent to --stdin)
Get-Content params.json -Raw | smithue-cli exec my_action -

# --params-file: read params from a file directly
smithue-cli exec my_action --params-file params.json
```

All three input modes are **mutually exclusive** — supplying more than one at a time is an error (exit 1). An explicit source with empty content is also an error. Omitting params entirely defaults to `{}`.

## Security Notes
- Binds to 127.0.0.1 only. No external network exposure.
- Port files in `%LOCALAPPDATA%\.smithue` are ACL-restricted to the current Windows user.

## Uninstall

Use `purge` to fully clean up after removing SmithUE. Unlike `prune` (which removes stale port files during normal use), `purge` deletes the entire `%LOCALAPPDATA%\.smithue\` directory as the final step of uninstalling the CLI.

```bash
smithue-cli purge          # interactive: lists files and asks for confirmation
smithue-cli purge --dry-run  # preview what would be deleted
smithue-cli purge -y       # non-interactive full purge (CI/scripts)
```

### Options

| Flag | Description |
|---|---|
| `--force` | Skip liveness check; delete all files including non-portfiles |
| `--dry-run` | Show what would be deleted without making changes |
| `-y, --yes` | Skip the confirmation prompt (required when stdin is not a TTY) |

### Exit codes

| Code | Meaning |
|---|---|
| 0 | Success (including cancelled and dry-run) |
| 1 | Non-interactive context without `-y` |
| 2 | `LOCALAPPDATA` not set (Windows-only command) |
| 3 | `.smithue` is a symlink or junction — refused for safety |

For routine cleanup of stale portfiles without removing the directory, use `smithue-cli prune` instead.

## Exit Codes

| Code | Meaning | Common cause |
|---|---|---|
| `0` | Success | Command completed normally |
| `1` | Bad input or disambiguation required | Invalid arguments; multiple instances running without `--pid`/`--project`; `PAYLOAD_TOO_LARGE` |
| `2` | Not found or unreachable | No portfiles found; instance unreachable; PID/project not matched |
| `3` | Command error | `PIE_LOCKED`, `ASSET_NOT_FOUND`, `INVALID_REQUEST`, or unknown plugin error |
| `4` | Internal / editor not ready | `INTERNAL_ERROR`, `EDITOR_NOT_READY`, unexpected exception |
| `5` | Stale session NID | `STALE_NID` — node ID is outdated, re-run the command |
| `6` | Wait timeout | `--wait` exceeded without editor becoming ready |

Scripts can branch on exit codes:
```powershell
smithue-cli status
if ($LASTEXITCODE -eq 2) { Write-Host "Editor not running" }
if ($LASTEXITCODE -eq 5) { Write-Host "Reconnecting (stale NID)..." }
```

## Known Limitations
- Version 1 is Windows-only due to portfile path conventions.
- No persistent configuration files. Use environment variables like `SMITHUE_PORT` or `SMITHUE_PID` for overrides.

## Maintainers

Publishing this package (git + npm) follows a fixed runbook — see **[`docs/RELEASE.md`](docs/RELEASE.md)** (registry gotcha, version bump, CJK-safe commit, `files` whitelist, skill deploy). The SmithUE plugin (separate repo, independent version) has its own release spec in the plugin's `docs/spec/RELEASE.md`.

smithue-cli

오너의 다른 레포

파일 탐색기

# CDN으로 사용하기

Was this content helpful?

Recent Feedback

smithue-cli

오너의 다른 레포

파일 탐색기

# CDN으로 사용하기

Was this content helpful?

Recent Feedback

Download README