Skip to content

Commit 2ba5567

Browse files
committed
Update documentation for importing skills and clarify AUR package handling
- Revised the "Importing a skill" documentation for clarity and consistency, including updated descriptions and instructions. - Enhanced the AUR README to specify the removal of the bundled `/usr/bin/opencode` file to prevent conflicts with `opencode-bin`, ensuring compatibility with existing installations.
1 parent 0864d81 commit 2ba5567

2 files changed

Lines changed: 26 additions & 20 deletions

File tree

Lines changed: 17 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,53 +1,53 @@
11
---
22
title: "Importing a skill"
3-
description: "How to import an external skill to your workspace in Openwork"
3+
description: "How to import an external skill into your workspace in OpenWork"
44
---
55

66
There are currently three direct ways to import an external skill.
77

8-
1. Importing an existing skill with share.openworklabs
9-
2. Pasting a skill in share.openworklabs, then importing it.
10-
3. Creating a skill using `Create skill in chat` and pasting the external skill
8+
1. Open an existing skill share link from `share.openworklabs.com`
9+
2. Paste a skill into the share site, then import it
10+
3. Create a skill with `Create skill in chat` and paste the external skill into that flow
1111

12-
There is another option if you're technical which is pasting it into the `workspace/skills` folder.
12+
There is another option if you're technical: place it directly in `.opencode/skills/<skill-name>/SKILL.md` inside your workspace.
1313

14-
We recommend using (1) and (3) as they're the options more directly compatible and easy to use.
14+
We recommend (1) and (3) because they match the built-in OpenWork flows most closely.
1515

1616
## Importing an existing skill with a share URL
1717

18-
When you have an openwork [Share URL](https://share.openwork.software/b/01KKPSGYSGDRRWNTAACAMZY3PF), you just need to click `Open in Openwork`
18+
When you have an OpenWork [share URL](https://share.openwork.software/b/01KKPSGYSGDRRWNTAACAMZY3PF), click `Open in OpenWork`.
1919

2020
<Frame>
2121
![Share page with Open in OpenWork button](/images/skill-import-share-page.png)
2222
</Frame>
2323

24-
Then, select the workspace in which you'd like to import it into (eg: in this case, `the-factory`).
24+
Then select the workspace where you want to install it (for example, `the-factory`).
2525

2626
<Frame>
2727
![Select workspace dialog for importing a skill](/images/skill-import-select-workspace.png)
2828
</Frame>
2929

30-
Once this is installed, Openwork will prompt you to reload so that it can load the skill into your workspace.
30+
Once the skill is installed, OpenWork prompts you to reload so it can load the new skill into your workspace.
3131

3232
<Frame>
3333
![Reload required banner after installing a skill](/images/skill-import-reload-required.png)
3434
</Frame>
3535

36-
Once you've reloaded the app, you should be able to use it directly into your workspace:
36+
After you reload the app, you can use the skill directly in that workspace:
3737

3838
<Frame>
3939
![Using an imported skill in chat with autocomplete](/images/skill-import-use-in-chat.png)
4040
</Frame>
4141

42-
## Pasting a skill in share.openworklabs, then importing it.
42+
## Pasting a skill into the share site, then importing it
4343

44-
In this case, you start at [the skills share page](https://share.openwork.software/) without any skill. Paste or upload the skill there, and click on generate link:
44+
Start at [the OpenWork share page](https://share.openworklabs.com/) without any skill loaded. Paste or upload the skill there, then click `Generate link`:
4545

4646
<Frame>
4747
![Share your skill page with Generate share link button](/images/skill-import-share-your-skill.png)
4848
</Frame>
4949

50-
**Note**: In order to import an external skill, the skill needs to adhere to the following structure:
50+
To import an external skill, the file needs to follow this structure:
5151

5252
```text
5353
---
@@ -58,17 +58,14 @@ description: one line description of what the skill does
5858
Any markdown text with instructions and description of the skill
5959
```
6060

61-
Make sure it follows this format when importing external skills from other marketplaces
61+
Make sure the file follows that format when importing skills from other marketplaces or other teams.
6262

63-
This then redirects you to the `Share Page` of a valid skill, and you can follow the steps from the previous section directly.
63+
That redirects you to the share page for the valid skill, and from there you can follow the steps from the previous section.
6464

65-
## Creating a skill using `/skill-creator` in the chat
65+
## Creating a skill with `/skill-creator` in chat
6666

67-
This option is quite straightforward, you can type `/skill-creator` in the chatand either directly paste the external skill you're seeking to import or describe what you'd like for the skill to do -and then, it will proceed to generate it.
67+
Type `/skill-creator` in chat, then either paste the external skill you want to import or describe what you want the skill to do. OpenWork will generate a workspace-local skill from that input.
6868

6969
<Frame>
7070
![Using the /skill-creator command in chat](/images/skill-import-skill-creator-command.png)
7171
</Frame>
72-
73-
<Frame>
74-
</Frame>

packaging/aur/README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ Use this directory to build and install the AMD64 OpenWork package locally on Ar
77
- Targets `x86_64` Arch Linux.
88
- Downloads the published GitHub release asset `openwork-desktop-linux-amd64.deb`.
99
- Repackages the `.deb` contents into an Arch package with `makepkg`.
10+
- Removes the bundled `/usr/bin/opencode` file so the package does not conflict with `opencode-bin`.
1011

1112
## Prerequisites
1213

@@ -36,6 +37,14 @@ That will:
3637
2. build an Arch package such as `openwork-<version>-1-x86_64.pkg.tar.zst`
3738
3. install it locally with `pacman`
3839

40+
After install, `openwork` is available as the desktop launcher. If you also want the standalone OpenCode CLI, install `opencode-bin` separately.
41+
42+
## OpenCode CLI conflict note
43+
44+
Recent `.deb` builds include `/usr/bin/opencode`, but the AUR package intentionally strips that file during repackaging.
45+
46+
That keeps OpenWork compatible with systems that already install the OpenCode CLI from `opencode-bin`, which should remain the owner of the global `opencode` command.
47+
3948
## Update the package to a newer release
4049

4150
If the GitHub release version changed, refresh the packaging metadata first:

0 commit comments

Comments
 (0)