eliott/openwork
1
0
Fork 0
mirror of https://github.com/different-ai/openwork synced 2026-04-25 17:15:34 +02:00
Code Issues Packages Projects Releases Wiki Activity

Update documentation for importing skills and clarify AUR package handling (#1325)

Browse Source 
- 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.
This commit is contained in:
Jan Carbonell
2026-04-04 01:41:39 -06:00
committed by GitHub
parent 3866938483
commit 5a0083fda8
2 changed files with 26 additions and 20 deletions
Download Patch File Download Diff File Expand all files Collapse all files

37
packages/docs/importing-a-skill.mdx
View File

@@ -1,53 +1,53 @@
---
title: "Importing a skill"
description: "How to import an external skill to your workspace in Openwork"
description: "How to import an external skill into your workspace in OpenWork"
---
There are currently three direct ways to import an external skill.
1. Importing an existing skill with share.openworklabs
2. Pasting a skill in share.openworklabs, then importing it.
3. Creating a skill using `Create skill in chat` and pasting the external skill
1. Open an existing skill share link from `share.openworklabs.com`
2. Paste a skill into the share site, then import it
3. Create a skill with `Create skill in chat` and paste the external skill into that flow
There is another option if you're technical which is pasting it into the `workspace/skills` folder.
There is another option if you're technical: place it directly in `.opencode/skills/<skill-name>/SKILL.md` inside your workspace.
We recommend using (1) and (3) as they're the options more directly compatible and easy to use.
We recommend (1) and (3) because they match the built-in OpenWork flows most closely.
## Importing an existing skill with a share URL
When you have an openwork [Share URL](https://share.openwork.software/b/01KKPSGYSGDRRWNTAACAMZY3PF), you just need to click `Open in Openwork`
When you have an OpenWork [share URL](https://share.openwork.software/b/01KKPSGYSGDRRWNTAACAMZY3PF), click `Open in OpenWork`.
<Frame>
![Share page with Open in OpenWork button](/images/skill-import-share-page.png)
</Frame>
Then, select the workspace in which you'd like to import it into (eg: in this case, `the-factory`).
Then select the workspace where you want to install it (for example, `the-factory`).
<Frame>
![Select workspace dialog for importing a skill](/images/skill-import-select-workspace.png)
</Frame>
Once this is installed, Openwork will prompt you to reload so that it can load the skill into your workspace.
Once the skill is installed, OpenWork prompts you to reload so it can load the new skill into your workspace.
<Frame>
![Reload required banner after installing a skill](/images/skill-import-reload-required.png)
</Frame>
Once you've reloaded the app, you should be able to use it directly into your workspace:
After you reload the app, you can use the skill directly in that workspace:
<Frame>
![Using an imported skill in chat with autocomplete](/images/skill-import-use-in-chat.png)
</Frame>
## Pasting a skill in share.openworklabs, then importing it.
## Pasting a skill into the share site, then importing it
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:
Start at [the OpenWork share page](https://share.openworklabs.com/) without any skill loaded. Paste or upload the skill there, then click `Generate link`:
<Frame>
![Share your skill page with Generate share link button](/images/skill-import-share-your-skill.png)
</Frame>
**Note**: In order to import an external skill, the skill needs to adhere to the following structure:
To import an external skill, the file needs to follow this structure:
```text
---
@@ -58,17 +58,14 @@ description: one line description of what the skill does
Any markdown text with instructions and description of the skill
```
Make sure it follows this format when importing external skills from other marketplaces
Make sure the file follows that format when importing skills from other marketplaces or other teams.
This then redirects you to the `Share Page` of a valid skill, and you can follow the steps from the previous section directly.
That redirects you to the share page for the valid skill, and from there you can follow the steps from the previous section.
## Creating a skill using `/skill-creator` in the chat
## Creating a skill with `/skill-creator` in chat
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.
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.
<Frame>
![Using the /skill-creator command in chat](/images/skill-import-skill-creator-command.png)
</Frame>
<Frame>
</Frame>