docs: add usage notes
This commit is contained in:
1
.gitignore
vendored
1
.gitignore
vendored
@@ -1,3 +1,4 @@
|
||||
build/bin
|
||||
node_modules
|
||||
frontend/dist
|
||||
frontend/package.json.md5
|
||||
|
||||
52
README.md
52
README.md
@@ -1,19 +1,47 @@
|
||||
# README
|
||||
# SGG AI Skill Manager Windows
|
||||
|
||||
## About
|
||||
Wails desktop app for managing AI skills from a Gitea organization. A Gitea repository is treated as a skill only when `SKILL.md` exists at the repository root.
|
||||
|
||||
This is the official Wails React-TS template.
|
||||
## Usage
|
||||
|
||||
You can configure the project by editing `wails.json`. More information about the project settings can be found
|
||||
here: https://wails.io/docs/reference/project-config
|
||||
1. Open the app and configure Gitea `baseURL`, organization, and authentication.
|
||||
2. Use username/password by default, or switch to token authentication.
|
||||
3. Save the config, then use Remote Market to refresh available skills.
|
||||
4. Download a skill to clone it under `%APPDATA%\sgg-ai-skill-manager\repos\{org}\{repo}`.
|
||||
5. Use Local Skills to install a downloaded skill into Codex or Claude.
|
||||
|
||||
## Live Development
|
||||
Install creates Windows directory Junctions:
|
||||
|
||||
To run in live development mode, run `wails dev` in the project directory. This will run a Vite development
|
||||
server that will provide very fast hot reload of your frontend changes. If you want to develop in a browser
|
||||
and have access to your Go methods, there is also a dev server that runs on http://localhost:34115. Connect
|
||||
to this in your browser, and you can call your Go code from devtools.
|
||||
```text
|
||||
C:\Users\{user}\.codex\skills\{repo}
|
||||
-> %APPDATA%\sgg-ai-skill-manager\repos\{org}\{repo}
|
||||
|
||||
## Building
|
||||
C:\Users\{user}\.claude\skills\{repo}
|
||||
-> %APPDATA%\sgg-ai-skill-manager\repos\{org}\{repo}
|
||||
```
|
||||
|
||||
To build a redistributable, production mode package, use `wails build`.
|
||||
Uninstall removes only the Junction created by this app. Delete removes the local cloned skill after safe uninstall of recorded Junctions.
|
||||
|
||||
## Local Data
|
||||
|
||||
```text
|
||||
%APPDATA%\sgg-ai-skill-manager\config.json
|
||||
%APPDATA%\sgg-ai-skill-manager\state.json
|
||||
%APPDATA%\sgg-ai-skill-manager\repos
|
||||
```
|
||||
|
||||
Passwords and tokens are stored through Windows Credential Manager, not in JSON files.
|
||||
|
||||
## Development
|
||||
|
||||
```powershell
|
||||
go test ./...
|
||||
npm --prefix frontend run build
|
||||
wails dev
|
||||
```
|
||||
|
||||
## Build
|
||||
|
||||
```powershell
|
||||
wails build
|
||||
```
|
||||
|
||||
6
go.mod
6
go.mod
@@ -2,7 +2,10 @@ module sgg-ai-skill-manager
|
||||
|
||||
go 1.23.0
|
||||
|
||||
require github.com/wailsapp/wails/v2 v2.12.0
|
||||
require (
|
||||
github.com/wailsapp/wails/v2 v2.12.0
|
||||
github.com/zalando/go-keyring v0.2.8
|
||||
)
|
||||
|
||||
require (
|
||||
git.sr.ht/~jackmordaunt/go-toast/v2 v2.0.3 // indirect
|
||||
@@ -30,7 +33,6 @@ require (
|
||||
github.com/valyala/fasttemplate v1.2.2 // indirect
|
||||
github.com/wailsapp/go-webview2 v1.0.22 // indirect
|
||||
github.com/wailsapp/mimetype v1.4.1 // indirect
|
||||
github.com/zalando/go-keyring v0.2.8 // indirect
|
||||
golang.org/x/crypto v0.33.0 // indirect
|
||||
golang.org/x/net v0.35.0 // indirect
|
||||
golang.org/x/sys v0.30.0 // indirect
|
||||
|
||||
8
go.sum
8
go.sum
@@ -8,8 +8,6 @@ github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c
|
||||
github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
|
||||
github.com/go-ole/go-ole v1.3.0 h1:Dt6ye7+vXGIKZ7Xtk4s6/xVdGDQynvom7xCFEdWr6uE=
|
||||
github.com/go-ole/go-ole v1.3.0/go.mod h1:5LS6F96DhAwUc7C+1HLexzMXY1xGRSryjyPPKW6zv78=
|
||||
github.com/godbus/dbus/v5 v5.1.0 h1:4KLkAxT3aOY8Li4FRJe/KvhoNFFxo0m6fNuFUO8QJUk=
|
||||
github.com/godbus/dbus/v5 v5.1.0/go.mod h1:xhWf0FNVPg57R7Z0UbKHbJfkEywrmjJnf7w5xrFpKfA=
|
||||
github.com/godbus/dbus/v5 v5.2.2 h1:TUR3TgtSVDmjiXOgAAyaZbYmIeP3DPkld3jgKGV8mXQ=
|
||||
github.com/godbus/dbus/v5 v5.2.2/go.mod h1:3AAv2+hPq5rdnr5txxxRwiGjPXamgoIHgz9FPBfOp3c=
|
||||
github.com/google/uuid v1.6.0 h1:NIvaJDMOsjHA8n1jAhLSgzrAzy1Hgr+hNrb57e+94F0=
|
||||
@@ -51,8 +49,10 @@ github.com/rivo/uniseg v0.4.7 h1:WUdvkW8uEhrYfLC4ZzdpI2ztxP1I582+49Oc5Mq64VQ=
|
||||
github.com/rivo/uniseg v0.4.7/go.mod h1:FN3SvrM+Zdj16jyLfmOkMNblXMcoc8DfTHruCPUcx88=
|
||||
github.com/samber/lo v1.49.1 h1:4BIFyVfuQSEpluc7Fua+j1NolZHiEHEpaSEKdsH0tew=
|
||||
github.com/samber/lo v1.49.1/go.mod h1:dO6KHFzUKXgP8LDhU0oI8d2hekjXnGOu0DB8Jecxd6o=
|
||||
github.com/stretchr/testify v1.10.0 h1:Xv5erBjTwe/5IxqUQTdXv5kgmIvbHo3QQyRwhJsOfJA=
|
||||
github.com/stretchr/testify v1.10.0/go.mod h1:r2ic/lqez/lEtzL7wO/rwa5dbSLXVDPFyf8C91i36aY=
|
||||
github.com/stretchr/objx v0.5.2 h1:xuMeJ0Sdp5ZMRXx/aWO6RZxdr3beISkG5/G/aIRr3pY=
|
||||
github.com/stretchr/objx v0.5.2/go.mod h1:FRsXN1f5AsAjCGJKqEizvkpNtU+EGNCLh3NxZ/8L+MA=
|
||||
github.com/stretchr/testify v1.11.1 h1:7s2iGBzp5EwR7/aIZr8ao5+dra3wiQyKjjFuvgVKu7U=
|
||||
github.com/stretchr/testify v1.11.1/go.mod h1:wZwfW3scLgRK+23gO65QZefKpKQRnfz6sD981Nm4B6U=
|
||||
github.com/tkrajina/go-reflector v0.5.8 h1:yPADHrwmUbMq4RGEyaOUpz2H90sRsETNVpjzo3DLVQQ=
|
||||
github.com/tkrajina/go-reflector v0.5.8/go.mod h1:ECbqLgccecY5kPmPmXg1MrHW585yMcDkVl6IvJe64T4=
|
||||
github.com/valyala/bytebufferpool v1.0.0 h1:GqA5TC/0021Y/b9FG4Oi9Mr3q7XYx6KllzawFIhcdPw=
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
{
|
||||
"$schema": "https://wails.io/schemas/config.v2.json",
|
||||
"name": "sgg-ai-skill-manager",
|
||||
"outputfilename": ".tmp-wails-scaffold",
|
||||
"outputfilename": "sgg-ai-skill-manager",
|
||||
"frontend:install": "npm install",
|
||||
"frontend:build": "npm run build",
|
||||
"frontend:dev:watcher": "npm run dev",
|
||||
|
||||
Reference in New Issue
Block a user