mirror of
https://github.com/runkids/skillshare.git
synced 2026-11-20 20:34:19 +00:00
docs: add AtomGit and Gitee to supported platform listings
- Add AtomGit/Gitee HTTPS examples in url-formats.md - Add AtomGit/Gitee column to Platform Support table - Update intro.md and comparison.md platform lists - Add AtomGit install E2E runbook (geo-restriction noted)
This commit is contained in:
@@ -0,0 +1,94 @@
|
||||
# AtomGit Install E2E Test
|
||||
|
||||
## Scope
|
||||
|
||||
Verify that skillshare can install skills from AtomGit (Chinese git platform) using full HTTPS URLs. This confirms the "any Git host" promise works for non-standard platforms.
|
||||
|
||||
## Known Limitation
|
||||
|
||||
AtomGit's git protocol (clone/ls-remote) returns **403** for non-China IPs. The HTTPS web interface (curl) returns 200, but `git clone` is geo-blocked. This means this runbook **can only run from a China-based machine or VPN**. The devcontainer (US/EU) cannot complete Steps 1-7.
|
||||
|
||||
**Verified via unit tests**: `gitHTTPSPattern` correctly parses `https://atomgit.com/owner/repo` — the URL parsing layer is fully covered.
|
||||
|
||||
## Environment
|
||||
|
||||
- Devcontainer with `ssenv` isolation (or China-based machine)
|
||||
- Network access required (online test — clones from `atomgit.com`)
|
||||
- Binary: `ss` (skillshare)
|
||||
|
||||
## Steps
|
||||
|
||||
### Step 1: Install from AtomGit full HTTPS URL
|
||||
|
||||
```bash
|
||||
ss install https://atomgit.com/Cangjie-SIG/cangjie-docs-mcp --all
|
||||
```
|
||||
|
||||
**Expected:**
|
||||
- Install completes without error
|
||||
- Output contains "Installed" or skill name
|
||||
- Exit code 0
|
||||
|
||||
### Step 2: Verify skill appears in list
|
||||
|
||||
```bash
|
||||
ss list --no-tui
|
||||
```
|
||||
|
||||
**Expected:**
|
||||
- Output contains at least one skill name from the installed repo
|
||||
- Skills are listed under source directory
|
||||
|
||||
### Step 3: Verify skill files exist on disk
|
||||
|
||||
```bash
|
||||
ls ~/.config/skillshare/skills/
|
||||
```
|
||||
|
||||
**Expected:**
|
||||
- At least one directory exists (skill from AtomGit repo)
|
||||
- Directory contains a `SKILL.md` or markdown files
|
||||
|
||||
### Step 4: Verify sync distributes to targets
|
||||
|
||||
```bash
|
||||
ss sync
|
||||
```
|
||||
|
||||
**Expected:**
|
||||
- Sync completes without error
|
||||
- Exit code 0
|
||||
|
||||
### Step 5: Verify symlinks created in Claude target
|
||||
|
||||
```bash
|
||||
ls -la ~/.claude/skills/
|
||||
```
|
||||
|
||||
**Expected:**
|
||||
- Symlinks exist pointing to `~/.config/skillshare/skills/` source
|
||||
- At least one symlink from the AtomGit-installed skill
|
||||
|
||||
### Step 6: Uninstall the skill
|
||||
|
||||
```bash
|
||||
ss uninstall cangjie-docs-mcp --force
|
||||
```
|
||||
|
||||
**Expected:**
|
||||
- Uninstall completes without error
|
||||
- Skill moved to trash
|
||||
- Exit code 0
|
||||
|
||||
### Step 7: Verify cleanup
|
||||
|
||||
```bash
|
||||
ss list --no-tui
|
||||
```
|
||||
|
||||
**Expected:**
|
||||
- The uninstalled skill no longer appears in the list
|
||||
|
||||
## Pass Criteria
|
||||
|
||||
All 7 steps pass. The full install → list → sync → uninstall lifecycle works for an AtomGit-hosted repository.
|
||||
@@ -71,7 +71,7 @@ Edit in source → all targets update. Edit in target → changes go to source (
|
||||
- **Dual-Level Architecture** — Organization skills for company standards + project skills for repo context
|
||||
- **Instant Updates** — Symlink-based sync means edits reflect immediately across all AI tools
|
||||
- **Team Ready** — Organization skills via tracked repos, project skills via git commit
|
||||
- **Any Git Host** — Install, update, and check from GitHub, GitLab, Bitbucket, Azure DevOps, or any self-hosted Git
|
||||
- **Any Git Host** — Install, update, and check from GitHub, GitLab, Bitbucket, Azure DevOps, AtomGit, Gitee, or any self-hosted Git
|
||||
- **Security Audit** — Scan skills for prompt injection, data exfiltration, and threats. Auto-scans on install
|
||||
|
||||
## Supported Platforms
|
||||
|
||||
@@ -67,6 +67,12 @@ skillshare install https://bitbucket.org/owner/repo
|
||||
|
||||
# Self-hosted Gitea
|
||||
skillshare install https://git.mycompany.com/team/skills
|
||||
|
||||
# AtomGit (China)
|
||||
skillshare install https://atomgit.com/owner/repo
|
||||
|
||||
# Gitee (China)
|
||||
skillshare install https://gitee.com/owner/repo
|
||||
```
|
||||
|
||||
## SSH URLs
|
||||
@@ -196,13 +202,13 @@ If you get an authentication error with HTTPS, switch to SSH URLs. skillshare se
|
||||
|
||||
## Platform Support
|
||||
|
||||
| Feature | GitHub | GitLab | Bitbucket | Gitea | GHE | Azure DevOps |
|
||||
|---------|--------|--------|-----------|-------|-----|--------------|
|
||||
| Shorthand (`owner/repo`) | Yes | No | No | No | Yes | `ado:` prefix |
|
||||
| Full HTTPS URL | Yes | Yes | Yes | Yes | Yes | Yes |
|
||||
| SSH URL | Yes | Yes | Yes | Yes | Yes | Yes |
|
||||
| Subdirectory | Yes | Yes | Yes | Yes | Yes | Yes |
|
||||
| `skillshare search` | Yes | No | No | No | No | No |
|
||||
| Feature | GitHub | GitLab | Bitbucket | Gitea | GHE | Azure DevOps | AtomGit/Gitee |
|
||||
|---------|--------|--------|-----------|-------|-----|--------------|---------------|
|
||||
| Shorthand (`owner/repo`) | Yes | No | No | No | Yes | `ado:` prefix | No |
|
||||
| Full HTTPS URL | Yes | Yes | Yes | Yes | Yes | Yes | Yes |
|
||||
| SSH URL | Yes | Yes | Yes | Yes | Yes | Yes | Yes |
|
||||
| Subdirectory | Yes | Yes | Yes | Yes | Yes | Yes | Yes |
|
||||
| `skillshare search` | Yes | No | No | No | No | No | No |
|
||||
|
||||
## Related
|
||||
|
||||
|
||||
@@ -58,7 +58,7 @@ One command, no prompts, deterministic results every time.
|
||||
| **Offline operation** | Requires npx + network for CLI itself | Single binary, works offline after install |
|
||||
| **Web dashboard** | None | `skillshare ui` — visual management |
|
||||
| **Backup / restore** | None | `skillshare backup` / `skillshare restore` |
|
||||
| **Git platform support** | GitHub only for update/check (hardcoded to GitHub Trees API) | Any Git remote — GitHub, GitLab, Bitbucket, Gitea, self-hosted |
|
||||
| **Git platform support** | GitHub only for update/check (hardcoded to GitHub Trees API) | Any Git remote — GitHub, GitLab, Bitbucket, Azure DevOps, Gitea, AtomGit, Gitee, self-hosted |
|
||||
| **Runtime dependency** | Node.js + npm | None (single Go binary) |
|
||||
|
||||
## Common Pain Points Solved
|
||||
@@ -102,7 +102,7 @@ All targets are recreated instantly.
|
||||
|
||||
Imperative tools often rely on the GitHub Trees API for update checks, which means `update` and `check` silently skip skills from non-GitHub sources.
|
||||
|
||||
skillshare uses **local git operations** (`git fetch` + tree hash comparison) — it works with any Git remote, including GitLab, Bitbucket, Azure DevOps, Gitea, and self-hosted instances. No platform-specific API is required.
|
||||
skillshare uses **local git operations** (`git fetch` + tree hash comparison) — it works with any Git remote, including GitLab, Bitbucket, Azure DevOps, Gitea, AtomGit, Gitee, and any self-hosted instance. No platform-specific API is required.
|
||||
|
||||
```bash
|
||||
# All of these support install, update, and check:
|
||||
|
||||
Reference in New Issue
Block a user