94 lines
3.9 KiB
Markdown
94 lines
3.9 KiB
Markdown
# @smarthome.exchange/cli
|
|
|
|
🧰 The `shx` command line interface for initializing homes, agents, and automations.
|
|
|
|
This package is the developer entry point for creating local smarthome.exchange project structure. It creates `.shx` directories, writes typed agent stubs, writes automation files that import the SDK, and keeps CLI behavior thin so runtime logic stays in the hub, API, interfaces, and SDK packages.
|
|
|
|
## Issue Reporting and Security
|
|
|
|
For reporting bugs, issues, or security vulnerabilities, please visit [community.foss.global/](https://community.foss.global/). This is the central community hub for all issue reporting. Developers who sign and comply with our contribution agreement and go through identification can also get a [code.foss.global/](https://code.foss.global/) account to submit Pull Requests directly.
|
|
|
|
## Install
|
|
|
|
```bash
|
|
pnpm add @smarthome.exchange/cli
|
|
```
|
|
|
|
When installed as a package, the binary is available as `shx`.
|
|
|
|
## Commands
|
|
|
|
```bash
|
|
shx help
|
|
shx init birch-lane
|
|
shx open
|
|
shx agent new security-reviewer
|
|
shx automation new evening-check
|
|
```
|
|
|
|
| Command | What it does |
|
|
| --- | --- |
|
|
| `shx help` | Prints the command list. |
|
|
| `shx init [name]` | Creates `.shx/agents`, `.shx/automations`, `.shx/dashboards`, and `.shx/config.json`. |
|
|
| `shx open` | Prints the default local console URL to open after a hub is running. |
|
|
| `shx agent new <name>` | Writes `.shx/agents/<normalized-name>.ts` with an `IAgentDefinition` stub. |
|
|
| `shx automation new <name>` | Writes `.shx/automations/<normalized-name>.ts` with an SDK automation stub. |
|
|
|
|
## Generated Home Layout
|
|
|
|
```text
|
|
.shx/
|
|
config.json
|
|
agents/
|
|
comfort.ts
|
|
automations/
|
|
evening-check.ts
|
|
dashboards/
|
|
```
|
|
|
|
Generated automation files import from `@smarthome.exchange/sdk` and register a manual trigger with `on(...)`. Generated agent files import the `data` namespace from `@smarthome.exchange/interfaces` and export a typed `agent` definition.
|
|
|
|
## Programmatic API
|
|
|
|
The package root exports the CLI helpers too:
|
|
|
|
```ts
|
|
import { createAgent, createAutomation, initHome, normalizeFileStem, runCli } from '@smarthome.exchange/cli';
|
|
|
|
console.log(normalizeFileStem('Evening Check!'));
|
|
|
|
await initHome('birch-lane');
|
|
await createAgent('Security Reviewer');
|
|
await createAutomation('Evening Check');
|
|
await runCli(['help']);
|
|
```
|
|
|
|
## Scripts
|
|
|
|
```bash
|
|
pnpm test
|
|
pnpm build
|
|
pnpm buildDocs
|
|
```
|
|
|
|
## License and Legal Information
|
|
|
|
This repository contains open-source code licensed under the MIT License. A copy of the license can be found in the [LICENSE](./license) file.
|
|
|
|
**Please note:** The MIT License does not grant permission to use the trade names, trademarks, service marks, or product names of the project, except as required for reasonable and customary use in describing the origin of the work and reproducing the content of the NOTICE file.
|
|
|
|
### Trademarks
|
|
|
|
This project is owned and maintained by Task Venture Capital GmbH. The names and logos associated with Task Venture Capital GmbH and any related products or services are trademarks of Task Venture Capital GmbH or third parties, and are not included within the scope of the MIT license granted herein.
|
|
|
|
Use of these trademarks must comply with Task Venture Capital GmbH's Trademark Guidelines or the guidelines of the respective third-party owners, and any usage must be approved in writing. Third-party trademarks used herein are the property of their respective owners and used only in a descriptive manner, e.g. for an implementation of an API or similar.
|
|
|
|
### Company Information
|
|
|
|
Task Venture Capital GmbH\
|
|
Registered at District Court Bremen HRB 35230 HB, Germany
|
|
|
|
For any legal inquiries or further information, please contact us via email at hello@task.vc.
|
|
|
|
By using this repository, you acknowledge that you have read this section, agree to comply with its terms, and understand that the licensing of the code does not imply endorsement by Task Venture Capital GmbH of any derivative works.
|