diff --git a/packages/docs/importing-a-skill.mdx b/packages/docs/importing-a-skill.mdx index 6ace7277..c49887cc 100644 --- a/packages/docs/importing-a-skill.mdx +++ b/packages/docs/importing-a-skill.mdx @@ -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.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`. ![Share page with Open in OpenWork button](/images/skill-import-share-page.png) -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`). ![Select workspace dialog for importing a skill](/images/skill-import-select-workspace.png) -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. ![Reload required banner after installing a skill](/images/skill-import-reload-required.png) -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: ![Using an imported skill in chat with autocomplete](/images/skill-import-use-in-chat.png) -## 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`: ![Share your skill page with Generate share link button](/images/skill-import-share-your-skill.png) -**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. ![Using the /skill-creator command in chat](/images/skill-import-skill-creator-command.png) - - - \ No newline at end of file diff --git a/packaging/aur/README.md b/packaging/aur/README.md index d768520d..6266fc9d 100644 --- a/packaging/aur/README.md +++ b/packaging/aur/README.md @@ -7,6 +7,7 @@ Use this directory to build and install the AMD64 OpenWork package locally on Ar - Targets `x86_64` Arch Linux. - Downloads the published GitHub release asset `openwork-desktop-linux-amd64.deb`. - Repackages the `.deb` contents into an Arch package with `makepkg`. +- Removes the bundled `/usr/bin/opencode` file so the package does not conflict with `opencode-bin`. ## Prerequisites @@ -36,6 +37,14 @@ That will: 2. build an Arch package such as `openwork--1-x86_64.pkg.tar.zst` 3. install it locally with `pacman` +After install, `openwork` is available as the desktop launcher. If you also want the standalone OpenCode CLI, install `opencode-bin` separately. + +## OpenCode CLI conflict note + +Recent `.deb` builds include `/usr/bin/opencode`, but the AUR package intentionally strips that file during repackaging. + +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. + ## Update the package to a newer release If the GitHub release version changed, refresh the packaging metadata first: