Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
121 changes: 121 additions & 0 deletions docs/docs/agent_skills.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,121 @@
---
id: agent_skills
title: Agent Skills
---

Agent Skills are portable instructions that help AI agents discover how to work with a tool or project.

`lets` ships one bundled skill named `lets`. It explains how agents should inspect `lets.yaml`, discover available commands, prefer project-defined tasks, and safely modify lets configuration.

The feature is experimental and might change or be removed in a future release.

## What gets installed

The `lets` skill is installed as a standard Agent Skills directory:

```text
.agents/skills/lets/SKILL.md
```

For global installs, the same directory is created under your home directory:

```text
~/.agents/skills/lets/SKILL.md
```

Any compatible agent can discover the skill from those locations.

## Show the bundled skill

Print the bundled skill to stdout:

```bash
lets self skills show
```

Use this to inspect exactly what will be installed.

## Install the skill

Run the install command:

```bash
lets self skills install
```

Without flags, `lets` prompts you to choose local or global scope and shows the exact install path for each option.

Install for the current project:

```bash
lets self skills install --local
```

This writes to `.agents/skills/lets/` at the current Git repository root.

Install for the current user:

```bash
lets self skills install --global
```

This writes to `~/.agents/skills/lets/`.

Install to a custom skills directory:

```bash
lets self skills install --path /path/to/.agents/skills
```

Overwrite an existing installed skill:

```bash
lets self skills install --force
```

The optional skill name is accepted for compatibility:

```bash
lets self skills install lets
```

`lets` currently ships only the `lets` skill.

## Update the skill

Update installed copies to the version bundled in the current `lets` binary:

```bash
lets self skills update
```

You can also pass the skill name:

```bash
lets self skills update lets
```

Update checks the known local and global locations:

- `.agents/skills/lets/` at the current Git repository root
- `~/.agents/skills/lets/`

Skills installed with `--path` are not discovered by `update`; reinstall with `--path --force` to refresh a custom location.

## Remove the skill

There is no dedicated remove command. Delete the installed skill directory.

Remove the local project skill:

```bash
rm -rf .agents/skills/lets
```

Remove the global user skill:

```bash
rm -rf ~/.agents/skills/lets
```

After removal, compatible agents will stop discovering the bundled `lets` skill from that location.
3 changes: 3 additions & 0 deletions docs/docs/changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,9 @@ title: Changelog

## [Unreleased](https://github.com/lets-cli/lets/releases/tag/v0.0.X)

* `[Added]` Add `lets self skills` commands to show, install, and update the bundled lets agent skill.
* `[Docs]` Document the bundled lets Agent Skill and link it from the config reference.
* `[Changed]` Expand the bundled lets agent skill with config authoring guidance.
* `[Fixed]` Make root and `self` help paths delegate through Cobra help handling, and allow `--version` without requiring config.
* `[Refactoring]` Use Go 1.26 `errors.AsType` for type-safe error unwrapping.

Expand Down
6 changes: 6 additions & 0 deletions docs/docs/config.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ id: config
title: Config reference
---

- [Agent Skills](#agent-skills)
- [Top-level directives:](#top-level-directives)
- [Version](#version)
- [Shell](#shell)
Expand Down Expand Up @@ -33,6 +34,11 @@ title: Config reference
- [Aliasing:](#aliasing)
- [Env aliasing](#env-aliasing)

## Agent Skills

Agent Skills are not configured in `lets.yaml`. They are installed and managed with the `lets self skills` command.

Use [`lets self skills`](agent_skills.md) to show, install, update, or remove the bundled `lets` agent skill.

## Top-level directives:

Expand Down
1 change: 1 addition & 0 deletions docs/sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,7 @@ module.exports = {
},
"config",
"settings",
"agent_skills",
{
type: "category",
label: "API Reference",
Expand Down
1 change: 1 addition & 0 deletions internal/cmd/self.go
Original file line number Diff line number Diff line change
Expand Up @@ -26,5 +26,6 @@ func initSelfCmd(rootCmd *cobra.Command, version string, openURL func(string) er

selfCmd.AddCommand(initDocCommand(openURL))
selfCmd.AddCommand(initLspCommand(version))
selfCmd.AddCommand(initSkillsCommand())
selfCmd.AddCommand(initUpgradeCommand(version))
}
Loading
Loading