Skip to main content
Version: 2.20.0

Create a skill

You get a skill in three ways. Ask the agent for it in a session, start from a blueprint, or fill in the skill editor yourself. When you ask the agent, one message is enough. The agent also changes, shares, and deletes a skill for you.

What do you write into a skill?​

The When to use line decides when the agent loads the skill by itself. The content of the skill holds the steps the agent then follows. Write both for the agent, not for a reader. The agent fills both when it writes a skill for you.

Write a skill once, and stop repeating the same instructions. For the ways to run one, see Run a skill. That page also covers your favorites, the system skills, and the menu entry that turns a skill off.

Ask the agent for a skill​

You do not need the editor. Describe the skill you want in any session. Name the task of the skill and the words that must trigger it.

An example message:

Create a skill that summarizes the errors of the last deployment when I ask for a deploy check. Keep the confirmation short.

A session in which the user asks for a deploy check skill, and the agent replies that it created the skill deploy_check.

Write your own task and your own trigger instead. The last sentence of the example is optional. It keeps the reply of the agent short, and it becomes part of the skill.

The agent chooses the name of the skill. The reply shows it, in the example above deploy_check. Hyground cannot change that name later. See Can you change the name later?

A skill the agent creates is private. See Share a skill to open it to your installation.

Change and share a skill in a session​

Name the skill and ask for the change you want. In the session that created the skill, the change alone is enough.

A session in which the user asks for one change to the skill and then asks to share it, and the agent confirms both.

A share from a session has the same effect as Share. See Share a skill.

Edit with Hyground starts the same path for a skill that exists. It sits behind the three dots icon in the row of the skill. The editor also has an Edit with Hyground box in the lower right corner. See Edit a skill in the editor.

Create a skill from a blueprint​

A blueprint is a ready-made use case that the agent turns into a skill for you.

  1. Click the Skills icon in the left navigation.

  2. Click Create skill in the Skills panel.

  3. Click From blueprint. The Skill blueprints page opens.

  4. Click Create in Hyground on the blueprint you want.

    The Skill blueprints page with its search box, its tags, and a row of blueprints; the Create in Hyground button of one blueprint is marked.

A skill the agent creates is private. Share it if it must run from a schedule.

Needs marks a blueprint that reads from a connected system your installation does not have, for example Needs loki. You can still start it. Hyground then tells you which system is missing and creates no skill.

The tags above the list filter it. Pick several to see the blueprints that carry any of them.

Create a skill in the editor​

  1. Click the Skills icon in the left navigation.

  2. Click Create skill in the Skills panel.

  3. Click From scratch. The skill editor opens.

    The open Create skill menu at the top of the Skills panel; the Create skill button and the From scratch entry are marked.

  4. Type a name in Skill name.

  5. Type a summary of the skill in Description.

  6. Type one line in When to use.

  7. Optional: pick or type a category in Categories.

  8. Optional: clear Make private to share the skill immediately.

  9. Click Next: Instructions.

  10. Type the instructions of the skill.

  11. Click Save.

Hyground shows Saved as version 1 and opens the new skill.

Until the instructions hold text, Instructions on the left reads Required. The empty editor shows an example with the headings Goal, Steps, and Output. The example disappears when you type. The line under the editor counts the characters up to the minimum of 32.

Make private is set for a new skill. Its hint reads Only visible to you. Clear the box only if every user of your installation should get the skill.

Categories takes the categories the skill names itself. Its placeholder reads Pick a category or type a new one. The list opens when you click the field. Pick an existing category. To add a new one, type its name. Then click Create “name” at the top of the list.

On a shared skill, the hint under the field gives a warning. A category you type becomes available to everyone in your company. When categories were assigned to the skill from its options menu on a skills page, the hint names them, because they win. For that rule and for the categories themselves, see What is a category?.

A name you type into Categories cannot contain a comma. Hyground shows A category name cannot contain a comma. The name stays in the field. Remove the comma and press Enter again.

A category name also takes at most 32 characters. Hyground refuses to save the skill when a name is longer.

A category you type into a private skill stays with that skill. Share the skill to add the category to the set every user picks from.

Can you change the name later?​

No. The name is the command that runs the skill, so Hyground disables Skill name after the first save. The line under the field says so before you save. To use another name, click Copy under a new name under the field. Save the copy. Then delete the first skill.

What runs when two skills have the same name?​

Your private skill wins over a shared skill with the same name. A shared skill wins over a system skill with the same name. The editor says so under Skill name before you save. In the skills lists, the skill that loses carries Replaced for you or Replaced.

How long can each field be?​

The editor shows a counter under each field below. Categories carries a hint instead of a counter.

  • Skill name takes the name as you would say it, for example Check certificates. The line under the field shows the command Hyground makes from it, here /check_certificates. The command takes 5 to 64 characters: lowercase letters, digits, underscores, and hyphens. Hyground turns spaces into underscores and drops accents. The list then shows Check Certificates.
  • Description takes 16 to 512 characters.
  • When to use takes at most 512 characters. Its counter counts against 150 instead. Above 150 characters the field turns amber and Hyground still saves the line. A short line routes the agent better, as the warning says.
  • Categories takes at most 20 entries. Each name takes at most 32 characters. The field accepts more, and Hyground refuses the save.
  • The content of the skill takes at least 32 characters. Your installation sets the maximum. The counter under the editor names both numbers.

Hyground refuses to save some character sequences in the content. It names the line and column of the first one and underlines it in the editor. Move such an example into a supporting file.

Add a file to a skill​

The Instructions section of the editor holds the content of the skill. You can also add files to a skill, for example a script or an example output. The Supporting files list on the left names them.

  1. Click Add file under the Supporting files list.

    The empty Supporting files list of a skill with the Add file button marked.

  2. Type the file name.

  3. Press Enter. The new file opens in the editor.

  4. Type the content of the file.

  5. Click Save.

To remove a file, point to it in the list and click the bin icon. The file stays in the list, struck through, until you click Save. Click Restore in its line to keep it.

Your installation sets three budgets. They cap the number of supporting files, the size of one file, and their total size. For a supporting file, the line under the editor shows its size against the size limit. The defaults, and how an administrator changes them, are in Size limits on the Skills page.

Edit a skill in the editor​

  1. Click the Skills icon in the left navigation.

  2. Click the name of the skill in the list. The editor opens on Overview.

  3. Change the fields you want to change.

    The name, description, when-to-use, and categories fields of a saved skill; the Description field is marked.

  4. Click Save.

Hyground shows the number of the new version, for example Saved as version 4. You can also press Ctrl+S, or ⌘+S on a Mac. Save stays inactive until you change something. Discard changes next to Save drops every change since the last save.

A shared skill is open to everyone. Every user of your installation can edit it, and every user can delete it. Only the user who created it can take it back into private use.

Hyground can also change a skill for you. Click Edit with Hyground in the lower right corner of the editor. A box opens next to the skill. Type what to change, or click one of the suggestions. When the agent saves a change, the editor shows the new version.

Save your changes first. The box asks you to save while the editor holds unsaved changes.

Your administrator can deny your role the right to create and change shared skills. The editor then opens a shared skill read-only. A bar above it reads Shared skills are read-only for you and offers Copy to my skills. Edit with Hyground is absent.

You can still view a shared skill, export it, and assign categories to it from its options menu. You cannot share or unshare a skill, and every skill you create stays private. The agent cannot change, share, or unshare a shared skill for you either. See What are you allowed to do?.

Who created a skill?​

Overview in the editor names the users behind the skill. A Created by badge names the user who created it. A Last modified by badge names the user who made the latest change to the skill.

Restoring a version, enabling the skill, and disabling it also update Last modified by. While you view a version that is not active, Last modified by names the user who saved that version.

A badge reads Hyground when the agent created or changed the skill. It reads Unknown user when that user account no longer exists.

Go back to an earlier version of a skill​

Every save that changes a skill creates a new version. This includes the changes the agent makes. The agent loads one version, the active one.

  1. Click the Skills icon in the left navigation.
  2. Click the name of the skill in the list. The editor opens.
  3. Click the version field in the header of the editor, for example Version 4. The Version history list opens.
  4. Click a version without the Active tag, for example Version 2. The editor shows it read-only.
  5. Click Restore version 2 in the bar that reads Viewing version 2 (read-only).
  6. Click Yes in the Restore version 2? dialog.

Hyground shows Version 2 restored. The agent uses version 2 the next time it loads the skill. A restore creates no new version. The other versions stay in the list.

In the Version history list, the Active tag marks the version that the agent loads. Each entry names the user who saved the version and the time of the save. An entry that reads edited from version 2 was saved while that earlier version was active.

To see what the version changes, click Show changes in the same bar. The dialog lists the lines that differ from the active version. It covers the description, When to use, the instructions, and each supporting file.

To close the version without a restore, click Back to the active version.

The version field stays inactive while the editor holds unsaved changes.

You can open the earlier versions of a shared skill that is read-only for you. You cannot restore them. A system skill shows no versions.

Share a skill​

  1. Click the Skills icon in the left navigation.

  2. Click the share icon in the row of the skill. Its tooltip reads Share.

    The actions of a private skill row with the share icon marked.

  3. Click Share in the dialog.

Hyground shows Skill shared. The share icon is now filled. A link to the private skill keeps working and opens the shared skill.

Share means every user of your installation, not a smaller group. Those users can run the skill, and the agent can load it in their sessions. You can unshare the skill later.

All users of your installation can also open every version of the skill. Text or a file that you remove in a later save stays in the earlier versions.

A scheduled session cannot use a private skill. Share a skill that must run from a schedule.

The share fails when a shared skill with the same name already exists. The dialog then says so, and the skill stays private. Create a second skill with another name and share that one.

The outlined share icon marks a private skill. A filled one marks a shared skill. Point to the icon to read its state when you cannot change it.

The three dots icon in the editor header offers Share too. Save your changes first. The entry stays inactive while the editor holds unsaved changes.

Unshare a skill​

  1. Click the Skills icon in the left navigation.

  2. Click the filled share icon in the row of the skill. Its tooltip reads Unshare.

    The actions of a shared skill row with the filled share icon marked.

  3. Click Unshare in the dialog.

Hyground shows Skill is now private (only visible to you). The share icon is outlined again. Other users lose the skill, and a scheduled session can no longer use it.

Only the user who created a shared skill can click the icon to unshare it. For every other user, the icon only shows that the skill is shared.

The three dots icon in the editor header offers Unshare too. Only the user who created the skill sees it. The entry stays inactive while the editor holds unsaved changes.

Delete a skill​

  1. Click the Skills icon in the left navigation.

  2. Click the three dots icon in the row of the skill.

  3. Click Delete.

    The open options menu of a skill row with the Delete entry marked.

  4. Click Delete in the dialog.

Hyground shows Skill deleted successfully. You cannot undo this. If the skill was shared, it disappears for every user.

The three dots icon in the editor header offers Delete too.

Which skills can you edit?​

The User Skills page lists your own skills and the skills other users shared. Use the All, Private, and Shared buttons above the list to filter it. For the other skills pages, see Find a skill.

You cannot edit a system skill, but you can read one. Hyground opens it without the Save button and the bin icon. See Read a system skill.