Using Plugins

Using Plugins

Install, enable, and configure atlcli plugins.

Prerequisites

• atlcli installed and configured
• Write access to ~/.atlcli/ directory

Plugin Location

Plugins are stored at ~/.atlcli/plugins/.

Installing Plugins

From npm (future)

atlcli plugin install @atlcli/plugin-git

From Local File

atlcli plugin install ./my-plugin

From Git Repository (future)

atlcli plugin install https://github.com/user/atlcli-plugin-custom.git

Managing Plugins

List Installed

atlcli plugin list

Output:

Name     Version  Status   Description
git      1.0.0    enabled  Git integration
custom   0.1.0    disabled Custom workflow

Enable Plugin

atlcli plugin enable git

Disable Plugin

atlcli plugin disable git

Remove Plugin

atlcli plugin remove custom

Configuration

Global Config

Enable plugins in ~/.atlcli/config.json:

{
  "plugins": {
    "enabled": ["git"],
    "path": "~/.atlcli/plugins"
  }
}

Plugin-Specific Config

Some plugins have their own configuration:

{
  "plugins": {
    "git": {
      "autoCommit": true,
      "branch": "main"
    }
  }
}

Plugin Commands

Plugins can add new commands. Use atlcli plugin list to see what commands each plugin provides:

atlcli plugin list

Output includes commands from each plugin:

  git@1.0.0 (enabled)
    Git integration for Confluence sync
    Source: local (~/.atlcli/plugins/git)
    Commands: commit, status

Troubleshooting

Plugin Not Loading

1. Check plugin is enabled: atlcli plugin list
2. Verify plugin path exists
3. Check for syntax errors in plugin code

Command Conflicts

If two plugins define the same command, the first enabled wins. Disable conflicting plugins or use namespaced commands:

atlcli git:commit  # Namespaced command

Related Topics

• Creating Plugins - Build custom plugins
• Git Plugin - Git integration for Confluence sync
• Configuration - Plugin configuration options