DependencySpec

Struct DependencySpec 

Source
pub struct DependencySpec {
    pub path: String,
    pub name: Option<String>,
    pub version: Option<String>,
    pub tool: Option<String>,
    pub flatten: Option<bool>,
    pub install: Option<bool>,
}
Expand description

Dependency specification without the source field.

Used within resource files to declare dependencies on other resources from the same source repository. The source is implicit and inherited from the resource that declares the dependency.

Fields§

§path: String

Path to the dependency file within the source repository.

This can be either:

  • A specific file path: "agents/helper.md"
  • A glob pattern: "agents/*.md", "agents/**/review*.md"
§name: Option<String>

Optional custom name for the dependency in template context.

If specified, this name will be used as the key when accessing this dependency in templates (e.g., agpm.deps.agents.custom_name). If not specified, the name is derived from the path.

Example:

dependencies:
  agents:
    - path: "agents/complex-path/helper.md"
      name: "helper"
§version: Option<String>

Optional version constraint for the dependency.

If not specified, the version of the declaring resource is used. Supports the same version formats as manifest dependencies:

  • Exact version: "v1.0.0"
  • Latest: "latest"
  • Branch: "main"
  • Commit: "abc123..."
§tool: Option<String>

Optional tool specification for this dependency.

If not specified, inherits from parent (if parent’s tool supports this resource type) or falls back to the default tool for this resource type.

  • “claude-code” - Install to .claude/ directories
  • “opencode” - Install to .opencode/ directories
  • “agpm” - Install to .agpm/ directories
§flatten: Option<bool>

Optional flatten flag to control directory structure preservation.

When true, only the filename is used for installation (e.g., nested/dir/file.mdfile.md). When false (default for most resources), the full relative path is preserved.

Default values by resource type:

  • agents: true (flatten by default)
  • commands: true (flatten by default)
  • All others: false (preserve directory structure)
§install: Option<bool>

Optional flag to control whether the dependency should be installed to disk.

When false, the dependency will be resolved, fetched, and its content made available in template context via agpm.deps.<type>.<name>.content, but the file will not be written to the project directory. This is useful for snippet embedding use cases where you want to include content inline rather than as a separate file.

See crate::templating::ResourceTemplateData for details on how content is accessed in templates.

Default: true (install the file)

Example:

dependencies:
  snippets:
    - path: "snippets/rust-best-practices.md"
      install: false  # Don't create a separate file
      name: "best_practices"

Then use in template: {{ agpm.deps.snippets.best_practices.content }}

Trait Implementations§

Source§

impl Clone for DependencySpec

Source§

fn clone(&self) -> DependencySpec

Returns a duplicate of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for DependencySpec

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for DependencySpec

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl PartialEq for DependencySpec

Source§

fn eq(&self, other: &DependencySpec) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Serialize for DependencySpec

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl Eq for DependencySpec

Source§

impl StructuralPartialEq for DependencySpec

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> ErasedDestructor for T
where T: 'static,