beck 0.2.1

Local skills router CLI for AI agents. Your agent's skills, at its beck and call.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103

//! The `Adapter` trait: the single abstraction every agent-specific
//! installer implements.
//!
//! A canonical SKILL.md at `<skills_home>/<name>/SKILL.md` is translated
//! into a file another agent actually reads. The Claude Code adapter ships
//! in v0.2; Cursor and friends are deferred to v0.3 pending research on
//! their user-global install points.
//!
//! Contract is locked in `.rune/plan-beck-link-spec.md` ยง1. Do not add
//! methods to the trait without bumping the spec, because every new
//! adapter will inherit them.

use std::path::{Path, PathBuf};

use crate::agents::manifest::{Entry, InstallMode};
use crate::agents::skill::Skill;
use crate::error::{CliError, Result};

/// The plan an adapter produces for a single skill, before it touches
/// disk. Phase 4 (`beck link`) prints the plan in `--dry-run` mode.
///
/// `transform` is a pure function from a `Skill` to the bytes written to
/// `target`. `None` means "symlink the source file byte-for-byte"; that is
/// the Claude Code case.
#[derive(Debug)]
pub struct InstallPlan {
    /// Source file under `<skills_home>/<name>/SKILL.md`.
    pub source: PathBuf,
    /// Destination the adapter writes on `install()`.
    pub target: PathBuf,
    /// Symlink or Copy. Symlink is the default for adapters that do not
    /// need a format transform.
    pub mode: InstallMode,
    /// Pure transform applied to the `Skill` to produce the bytes written
    /// at `target` when `mode == Copy`. `None` means no transform.
    pub transform: Option<fn(&Skill) -> String>,
}

/// Every agent-specific installer implements this trait.
///
/// Lifetime contract:
/// 1. `plan(&skill)` is a pure read of `skill`. It must not touch disk
///    outside `target_root()` lookups.
/// 2. `install(&plan)` may create directories and the single file or
///    symlink at `plan.target`. It must not write anywhere else.
/// 3. `uninstall(&entry)` removes exactly the file `entry.target` and
///    must refuse if the file on disk is no longer beck-managed.
/// 4. Adapters are stateless and safe to share across threads. The
///    `Send + Sync` bound is load-bearing for the registry that owns
///    `Box<dyn Adapter>`.
pub trait Adapter: Send + Sync {
    /// Stable identifier written into `Entry::agent`. Must match the name
    /// Phase 4 accepts in `beck link --agent <name>`.
    fn name(&self) -> &'static str;

    /// True if the agent appears to be installed on the current machine.
    /// For Claude Code this means `~/.claude/` exists.
    fn detect(&self) -> bool;

    /// Root directory the adapter installs into, e.g.
    /// `~/.claude/skills/`. Returns `CliError::Validation` if the home
    /// directory cannot be resolved.
    fn target_root(&self) -> Result<PathBuf>;

    /// Compute the `InstallPlan` for a single skill. Pure: no disk writes.
    fn plan(&self, skill: &Skill) -> Result<InstallPlan>;

    /// Execute a plan. Returns the manifest `Entry` the caller should
    /// append. Idempotent: running twice on an already-beck-managed
    /// target returns the same entry without erroring.
    fn install(&self, plan: &InstallPlan) -> Result<Entry>;

    /// Remove a previously installed file. Must verify the file on disk
    /// is still beck-managed before touching it (no clobbering
    /// user-authored files).
    fn uninstall(&self, entry: &Entry) -> Result<()>;

    /// Phase 5 hook: walk `target_root()` and return every file that is
    /// currently beck-managed, keyed by absolute path. "beck-managed"
    /// means "installed by beck through this adapter": for Claude Code
    /// that is any symlink whose target canonicalizes under
    /// `<beck_home>/skills/`. The walk is shallow by design; adapters
    /// decide their own depth.
    fn list_managed(&self) -> Result<Vec<PathBuf>> {
        Ok(Vec::new())
    }

    /// Phase 5 hook: rebuild a `Manifest::Entry` for a target path by
    /// re-reading the file from disk. Used by `beck check
    /// --rebuild-manifest` to recover a lost manifest.
    fn rebuild_entry(&self, _target: &Path) -> Result<Entry> {
        Err(CliError::Validation(
            "rebuild_entry not implemented for this adapter".into(),
        ))
    }

    /// Phase 6 hook: walk the agent's native skills dir and return any
    /// skills that are NOT already symlinks back into `~/beck/skills/`.
    /// Default is empty for adapters that have not wired ingest yet.
    fn ingest(&self) -> Result<Vec<Skill>> {
        Ok(Vec::new())
    }
}