Skip to content

Commit e70b1af

Browse files
committed
refactor
1 parent 8258ac9 commit e70b1af

14 files changed

Lines changed: 3118 additions & 71 deletions

File tree

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
name: Daily Build
2+
3+
on:
4+
workflow_dispatch:
5+
schedule:
6+
- cron: '0 0 * * *'
7+
8+
jobs:
9+
publish:
10+
runs-on: ubuntu-latest
11+
steps:
12+
- name: Checkout repository
13+
uses: actions/checkout@v4
14+
15+
- name: Setup Node.js
16+
uses: actions/setup-node@v4
17+
with:
18+
node-version: '20'
19+
registry-url: 'https://registry.npmjs.org'
20+
21+
- name: Publish create-jsui-agent
22+
run: |
23+
cd packages/create-jsui-agent
24+
npm publish --access public
25+
env:
26+
NODE_AUTH_TOKEN: ${{ secrets.NODE_AUTH_TOKEN }}

β€Ž.github/workflows/publish-ink-docs.ymlβ€Ž

Lines changed: 0 additions & 67 deletions
This file was deleted.

β€Ž.gitignoreβ€Ž

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
node_modules/
2+
3+
.trae/specs/
4+
.trae/documents/

β€ŽREADME.mdβ€Ž

Lines changed: 44 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,47 @@
1-
# JSUI: JavaScript User Interface
1+
# JSUI Developer Tools & Skills
22

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.
44

5-
## Documentation
5+
## πŸš€ Quick Start
66

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

Comments
Β (0)