TargetConfig

Struct TargetConfig 

Source
pub struct TargetConfig {
    pub agents: String,
    pub snippets: String,
    pub commands: String,
    pub mcp_servers: String,
    pub scripts: String,
    pub hooks: String,
    pub gitignore: bool,
}
Expand description

Target directories configuration specifying where resources are installed.

This struct defines the installation destinations for different resource types within a AGPM project. All paths are relative to the project root (where agpm.toml is located) unless they are absolute paths.

§Default Values

  • Agents: .claude/agents - Following Claude Code conventions
  • Snippets: .agpm/snippets - AGPM-specific infrastructure (shared across tools)
  • Commands: .claude/commands - Following Claude Code conventions

§Path Resolution

  • Relative paths are resolved from the manifest directory
  • Absolute paths are used as-is (not recommended for portability)
  • Path separators are automatically normalized for the target platform
  • Directories are created automatically during installation if they don’t exist

§Examples

# Default configuration (can be omitted)
[target]
agents = ".claude/agents"
snippets = ".agpm/snippets"
commands = ".claude/commands"

# Custom configuration
[target]
agents = "resources/ai-agents"
snippets = "templates/code-snippets"
commands = "resources/commands"

# Absolute paths (use with caution)
[target]
agents = "/opt/claude/agents"
snippets = "/opt/claude/snippets"
commands = "/opt/claude/commands"

§Cross-Platform Considerations

AGPM automatically handles platform differences:

  • Forward slashes work on all platforms (Windows, macOS, Linux)
  • Path separators are normalized during installation
  • Long path support on Windows is handled automatically

Fields§

§agents: String

Directory where agent .md files should be installed.

Agents are AI model definitions, prompts, or behavioral specifications. This directory will contain copies of agent files from dependencies.

Default: .claude/agents (following Claude Code conventions)

§snippets: String

Directory where snippet .md files should be installed.

Snippets are reusable code templates, examples, or documentation. This directory will contain copies of snippet files from dependencies.

Default: .agpm/snippets (AGPM-specific infrastructure)

§commands: String

Directory where command .md files should be installed.

Commands are Claude Code slash commands that provide custom functionality. This directory will contain copies of command files from dependencies.

Default: .claude/commands (following Claude Code conventions)

§mcp_servers: String

Directory where MCP server configurations should be tracked.

Note: MCP servers are configured in .mcp.json at the project root, not installed to this directory. This directory is used for tracking metadata about installed servers.

Note: MCP servers are merged into .mcp.json - no separate directory

§scripts: String

Directory where script files should be installed.

Scripts are executable files (.sh, .js, .py, etc.) that can be referenced by hooks or run independently.

Default: .claude/scripts (Claude Code resource directory)

§hooks: String

Directory where hook configuration files should be installed.

Hooks are JSON configuration files that define event-based automation in Claude Code.

Note: Hooks are merged into .claude/settings.local.json - no separate directory

§gitignore: bool

Whether to automatically add installed files to .gitignore.

When enabled (default), AGPM will create or update .gitignore to exclude all installed files from version control. This prevents installed dependencies from being committed to your repository.

Set to false if you want to commit installed resources to version control.

Default: true

Trait Implementations§

Source§

impl Clone for TargetConfig

Source§

fn clone(&self) -> TargetConfig

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 TargetConfig

Source§

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

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

impl Default for TargetConfig

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for TargetConfig

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 Serialize for TargetConfig

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

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<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,