|
1 | | -# JSUI: JavaScript User Interface |
| 1 | +# JSUI Developer Tools & Skills |
2 | 2 |
|
3 | | -JSUI is a *JavaScript User Interface* agentic runtime designed for the AI glasses with Display. It empowers developers to build intelligent, interactive, and context-aware agents with GUI seamlessly. |
| 3 | +This repository provides developer tools, CLIs, and AI agent skills for building applications on **JSUI** (JavaScript User Interface) β an agentic runtime designed for AI glasses with displays. |
4 | 4 |
|
5 | | -## Documentation |
| 5 | +## π Quick Start |
6 | 6 |
|
7 | | -For more detailed information, tutorials, and API references, please visit our [official documentation](https://jsar-project.github.io/JSUI/). |
| 7 | +### Create a new JSUI Agent |
| 8 | + |
| 9 | +You can quickly scaffold a new JSUI Agent project using our official CLI tool. Run the following command and follow the prompts: |
| 10 | + |
| 11 | +```bash |
| 12 | +npm create jsui-agent my-agent |
| 13 | +``` |
| 14 | + |
| 15 | +This will generate a ready-to-use JSUI project template including: |
| 16 | +- `app.js` and `app.json` for global configuration. |
| 17 | +- `AGENTS.md` for agent capability manifestation. |
| 18 | +- A modern Single File Component (SFC) `index.ink` page setup. |
| 19 | + |
| 20 | +## π€ AI Agent Skills |
| 21 | + |
| 22 | +We provide built-in instructions and context files to help LLMs (Large Language Models) or AI coding assistants write JSUI code effectively. |
| 23 | + |
| 24 | +### Install via CLI |
| 25 | + |
| 26 | +You can easily install the JSUI developer skill into your project using the `npx skills add` command. This will fetch the necessary context files and make them available to your AI coding assistant: |
| 27 | + |
| 28 | +```bash |
| 29 | +npx skills add https://github.com/jsar-project/JSUI/tree/main/skills/jsui-dev |
| 30 | +``` |
| 31 | + |
| 32 | +- **`jsui-dev` Skill**: Located in [`skills/jsui-dev/SKILL.md`](./skills/jsui-dev/SKILL.md), this document contains comprehensive API references, project structure guidelines, and `.ink` SFC specifications. You can feed this file to your AI assistant to grant it the "skill" of developing JSUI applications. |
| 33 | + |
| 34 | +## π Repository Structure |
| 35 | + |
| 36 | +```text |
| 37 | +. |
| 38 | +βββ packages/ |
| 39 | +β βββ create-jsui-agent/ # npm CLI for scaffolding JSUI agent projects |
| 40 | +βββ skills/ |
| 41 | +β βββ jsui-dev/ # AI Agent skill documentation (SKILL.md) |
| 42 | +βββ .github/workflows/ # Automated daily build and publish workflows |
| 43 | +``` |
| 44 | + |
| 45 | +## π License |
| 46 | + |
| 47 | +Apache License 2.0 |
0 commit comments