Metadata-Version: 2.4
Name: lola-ai
Version: 0.7.0
Summary: AI Skills Package Manager
Author: Igor Brandao, Katie Mulliken
License: 
                                         Apache License
                                   Version 2.0, January 2004
                                http://www.apache.org/licenses/
        
           TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
        
           1. Definitions.
        
              "License" shall mean the terms and conditions for use, reproduction,
              and distribution as defined by Sections 1 through 9 of this document.
        
              "Licensor" shall mean the copyright owner or entity authorized by
              the copyright owner that is granting the License.
        
              "Legal Entity" shall mean the union of the acting entity and all
              other entities that control, are controlled by, or are under common
              control with that entity. For the purposes of this definition,
              "control" means (i) the power, direct or indirect, to cause the
              direction or management of such entity, whether by contract or
              otherwise, or (ii) ownership of fifty percent (50%) or more of the
              outstanding shares, or (iii) beneficial ownership of such entity.
        
              "You" (or "Your") shall mean an individual or Legal Entity
              exercising permissions granted by this License.
        
              "Source" form shall mean the preferred form for making modifications,
              including but not limited to software source code, documentation
              source, and configuration files.
        
              "Object" form shall mean any form resulting from mechanical
              transformation or translation of a Source form, including but
              not limited to compiled object code, generated documentation,
              and conversions to other media types.
        
              "Work" shall mean the work of authorship, whether in Source or
              Object form, made available under the License, as indicated by a
              copyright notice that is included in or attached to the work
              (an example is provided in the Appendix below).
        
              "Derivative Works" shall mean any work, whether in Source or Object
              form, that is based on (or derived from) the Work and for which the
              editorial revisions, annotations, elaborations, or other modifications
              represent, as a whole, an original work of authorship. For the purposes
              of this License, Derivative Works shall not include works that remain
              separable from, or merely link (or bind by name) to the interfaces of,
              the Work and Derivative Works thereof.
        
              "Contribution" shall mean any work of authorship, including
              the original version of the Work and any modifications or additions
              to that Work or Derivative Works thereof, that is intentionally
              submitted to Licensor for inclusion in the Work by the copyright owner
              or by an individual or Legal Entity authorized to submit on behalf of
              the copyright owner. For the purposes of this definition, "submitted"
              means any form of electronic, verbal, or written communication sent
              to the Licensor or its representatives, including but not limited to
              communication on electronic mailing lists, source code control systems,
              and issue tracking systems that are managed by, or on behalf of, the
              Licensor for the purpose of discussing and improving the Work, but
              excluding communication that is conspicuously marked or otherwise
              designated in writing by the copyright owner as "Not a Contribution."
        
              "Contributor" shall mean Licensor and any individual or Legal Entity
              on behalf of whom a Contribution has been received by Licensor and
              subsequently incorporated within the Work.
        
           2. Grant of Copyright License. Subject to the terms and conditions of
              this License, each Contributor hereby grants to You a perpetual,
              worldwide, non-exclusive, no-charge, royalty-free, irrevocable
              copyright license to reproduce, prepare Derivative Works of,
              publicly display, publicly perform, sublicense, and distribute the
              Work and such Derivative Works in Source or Object form.
        
           3. Grant of Patent License. Subject to the terms and conditions of
              this License, each Contributor hereby grants to You a perpetual,
              worldwide, non-exclusive, no-charge, royalty-free, irrevocable
              (except as stated in this section) patent license to make, have made,
              use, offer to sell, sell, import, and otherwise transfer the Work,
              where such license applies only to those patent claims licensable
              by such Contributor that are necessarily infringed by their
              Contribution(s) alone or by combination of their Contribution(s)
              with the Work to which such Contribution(s) was submitted. If You
              institute patent litigation against any entity (including a
              cross-claim or counterclaim in a lawsuit) alleging that the Work
              or a Contribution incorporated within the Work constitutes direct
              or contributory patent infringement, then any patent licenses
              granted to You under this License for that Work shall terminate
              as of the date such litigation is filed.
        
           4. Redistribution. You may reproduce and distribute copies of the
              Work or Derivative Works thereof in any medium, with or without
              modifications, and in Source or Object form, provided that You
              meet the following conditions:
        
              (a) You must give any other recipients of the Work or
                  Derivative Works a copy of this License; and
        
              (b) You must cause any modified files to carry prominent notices
                  stating that You changed the files; and
        
              (c) You must retain, in the Source form of any Derivative Works
                  that You distribute, all copyright, patent, trademark, and
                  attribution notices from the Source form of the Work,
                  excluding those notices that do not pertain to any part of
                  the Derivative Works; and
        
              (d) If the Work includes a "NOTICE" text file as part of its
                  distribution, then any Derivative Works that You distribute must
                  include a readable copy of the attribution notices contained
                  within such NOTICE file, excluding those notices that do not
                  pertain to any part of the Derivative Works, in at least one
                  of the following places: within a NOTICE text file distributed
                  as part of the Derivative Works; within the Source form or
                  documentation, if provided along with the Derivative Works; or,
                  within a display generated by the Derivative Works, if and
                  wherever such third-party notices normally appear. The contents
                  of the NOTICE file are for informational purposes only and
                  do not modify the License. You may add Your own attribution
                  notices within Derivative Works that You distribute, alongside
                  or as an addendum to the NOTICE text from the Work, provided
                  that such additional attribution notices cannot be construed
                  as modifying the License.
        
              You may add Your own copyright statement to Your modifications and
              may provide additional or different license terms and conditions
              for use, reproduction, or distribution of Your modifications, or
              for any such Derivative Works as a whole, provided Your use,
              reproduction, and distribution of the Work otherwise complies with
              the conditions stated in this License.
        
           5. Submission of Contributions. Unless You explicitly state otherwise,
              any Contribution intentionally submitted for inclusion in the Work
              by You to the Licensor shall be under the terms and conditions of
              this License, without any additional terms or conditions.
              Notwithstanding the above, nothing herein shall supersede or modify
              the terms of any separate license agreement you may have executed
              with Licensor regarding such Contributions.
        
           6. Trademarks. This License does not grant permission to use the trade
              names, trademarks, service marks, or product names of the Licensor,
              except as required for reasonable and customary use in describing the
              origin of the Work and reproducing the content of the NOTICE file.
        
           7. Disclaimer of Warranty. Unless required by applicable law or
              agreed to in writing, Licensor provides the Work (and each
              Contributor provides its Contributions) on an "AS IS" BASIS,
              WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
              implied, including, without limitation, any warranties or conditions
              of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
              PARTICULAR PURPOSE. You are solely responsible for determining the
              appropriateness of using or redistributing the Work and assume any
              risks associated with Your exercise of permissions under this License.
        
           8. Limitation of Liability. In no event and under no legal theory,
              whether in tort (including negligence), contract, or otherwise,
              unless required by applicable law (such as deliberate and grossly
              negligent acts) or agreed to in writing, shall any Contributor be
              liable to You for damages, including any direct, indirect, special,
              incidental, or consequential damages of any character arising as a
              result of this License or out of the use or inability to use the
              Work (including but not limited to damages for loss of goodwill,
              work stoppage, computer failure or malfunction, or any and all
              other commercial damages or losses), even if such Contributor
              has been advised of the possibility of such damages.
        
           9. Accepting Warranty or Additional Liability. While redistributing
              the Work or Derivative Works thereof, You may choose to offer,
              and charge a fee for, acceptance of support, warranty, indemnity,
              or other liability obligations and/or rights consistent with this
              License. However, in accepting such obligations, You may act only
              on Your own behalf and on Your sole responsibility, not on behalf
              of any other Contributor, and only if You agree to indemnify,
              defend, and hold each Contributor harmless for any liability
              incurred by, or claims asserted against, such Contributor by reason
              of your accepting any such warranty or additional liability.
        
           END OF TERMS AND CONDITIONS
        
           APPENDIX: How to apply the Apache License to your work.
        
              To apply the Apache License to your work, attach the following
              boilerplate notice, with the fields enclosed by brackets "[]"
              replaced with your own identifying information. (Don't include
              the brackets!)  The text should be enclosed in the appropriate
              comment syntax for the file format. We also recommend that a
              file or class name and description of purpose be included on the
              same "printed page" as the copyright notice for easier
              identification within third-party archives.
        
           Copyright [yyyy] [name of copyright owner]
        
           Licensed under the Apache License, Version 2.0 (the "License");
           you may not use this file except in compliance with the License.
           You may obtain a copy of the License at
        
               http://www.apache.org/licenses/LICENSE-2.0
        
           Unless required by applicable law or agreed to in writing, software
           distributed under the License is distributed on an "AS IS" BASIS,
           WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
           See the License for the specific language governing permissions and
           limitations under the License.
License-File: LICENSE
Requires-Python: >=3.13
Requires-Dist: click>=8.3.3
Requires-Dist: inquirerpy>=0.3.4
Requires-Dist: packaging>=24.0
Requires-Dist: pygments>=2.20.0
Requires-Dist: python-frontmatter>=1.1.0
Requires-Dist: pyyaml>=6.0.0
Requires-Dist: rich>=13.0.0
Provides-Extra: docs
Requires-Dist: mkdocs-awesome-pages-plugin>=2.9.0; extra == 'docs'
Requires-Dist: mkdocs-material>=9.0.0; extra == 'docs'
Requires-Dist: mkdocs-mermaid2-plugin>=1.0.0; extra == 'docs'
Requires-Dist: mkdocs-panzoom-plugin>=0.5.2; extra == 'docs'
Requires-Dist: mkdocs>=1.6.1; extra == 'docs'
Requires-Dist: pymdown-extensions>=10.21.2; extra == 'docs'
Description-Content-Type: text/markdown

# Lola - AI Context Package Manager

**Write Agent Skills and Contexts once, use everywhere.**

[![OpenSSF Best Practices](https://www.bestpractices.dev/projects/13138/badge)](https://www.bestpractices.dev/projects/13138)
[![Matrix](https://img.shields.io/badge/chat-Matrix-blue?logo=matrix)](https://matrix.to/#/#lola-ai:matrix.org)

Lola is a universal AI Package Manager. If an agent's skills were an RPM, Lola is the DNF for it. Write your [skills and context modules](https://lobstertrap.org/lola/concepts/skills-and-modules/) once as portable packages, then install them to any AI assistant or agent with a single command.

[![asciicast](https://asciinema.org/a/1035360.svg)](https://asciinema.org/a/1035360)

## Supported AI Assistants

| Assistant         | Skills | Commands | Agents |
| ----------------- | ------ | -------- | ------ |
| Claude Code       | Yes    | Yes      | Yes    |
| Copilot CLI       | Yes    | Yes      | Yes    |
| Copilot (VS Code) | Yes    | Yes¹     | Yes    |
| Cursor            | Yes    | Yes      | Yes    |
| Gemini CLI        | Yes    | Yes      | N/A    |
| OpenCode          | Yes    | Yes      | Yes    |

¹ Project scope only — VS Code has no user-scope location for slash commands.

GitHub Copilot has two targets that share the same `.github/` (project) and
`~/.copilot/` (user) files but differ in MCP handling:

- `copilot-cli` - writes MCP servers using the `mcpServers` key
  (`~/.copilot/mcp-config.json` for user scope).
- `copilot-vscode` - writes MCP servers to `.vscode/mcp.json` using VS
  Code's `servers` key. VS Code has no user-scope location for slash commands
  or MCP, so those are skipped (with a warning) when installing at user scope.

When no assistant is selected explicitly, `copilot-vscode` is preferred over
`copilot-cli` to avoid writing the same project files twice.

## Installation

```bash
# Recommended: install from PyPI
uv tool install lola-ai

# Or with pip
pip install lola-ai
```

> **Want the latest dev version?**
> `uv tool install git+https://github.com/LobsterTrap/lola`

## Quick Start

```bash
# Set up the official marketplace
lola market add general https://raw.githubusercontent.com/RedHatProductSecurity/lola-market/main/general-market.yml

# Add a module
lola mod add https://github.com/user/my-skills.git

# Install to all detected assistants
lola install my-skills

# Or install to a specific assistant
lola install my-skills -a claude-code
```

## Declarative Installation

Create a `.lola-req` in your project:

```
python-tools>=1.0.0
https://github.com/user/module.git@main
https://github.com/quay/ai-helpers.git@main#subdirectory=plugins/dev
https://github.com/user/repo.git#assistant=claude-code,cursor
```

URL fragments support:
- `subdirectory=path/to/module` - Install from a subdirectory in the repository
- `assistant=name1,name2` - Install to specific assistants

```bash
lola sync
```

## Documentation

Full documentation is available at **[lobstertrap.org/lola](https://lobstertrap.org/lola/)**.

### Official Lola Marketplace

We maintain an official, community-driven marketplace with curated modules at [github.com/RedHatProductSecurity/lola-market](https://github.com/RedHatProductSecurity/lola-market).

**Quick setup:**
```bash
lola market add general https://raw.githubusercontent.com/RedHatProductSecurity/lola-market/main/general-market.yml
```

This gives you instant access to community modules like workflow automation, code quality tools, and more. **We highly encourage you to:**
- Use modules from the official marketplace
- Contribute your own modules
- Share feedback and improvements

All contributions are welcome! See the [marketplace contributing guide](https://github.com/RedHatProductSecurity/lola-market/blob/main/CONTRIBUTING.md).

### Register a marketplace

```bash
# Add a marketplace from a URL
lola market add general https://raw.githubusercontent.com/RedHatProductSecurity/lola-market/main/general-market.yml

# List registered marketplaces
lola market ls
```

### Search and install from marketplace

```bash
# Search across all enabled marketplaces
lola mod search authentication

# Install directly from marketplace (auto-adds and installs)
lola install git-workflow -a claude-code
```

When a module exists in multiple marketplaces, Lola prompts you to select which one to use.

### Manage marketplaces

```bash
# Update marketplace cache
lola market update general

# Update all marketplaces
lola market update

# Disable a marketplace (keeps it registered but excludes from search)
lola market set --disable general

# Re-enable a marketplace
lola market set --enable general

# Remove a marketplace
lola market rm general
```

### Marketplace YAML format

Create your own marketplace by hosting a YAML file with this structure:

```yaml
name: My Marketplace
description: Curated collection of AI skills
version: 1.0.0
modules:
  - name: git-workflow
    description: Git workflow automation skills
    version: 1.0.0
    repository: https://github.com/user/git-workflow.git
    tags: [git, workflow]

  - name: code-review
    description: Code review assistant skills
    version: 1.2.0
    repository: https://github.com/user/code-review.git
    tags: [review, quality]
```

**Fields:**
- `name`: Marketplace display name
- `description`: What this marketplace provides
- `version`: Marketplace schema version
- `modules`: List of available modules
  - `name`: Module name (must match repository directory name)
  - `description`: Brief description shown in search results
  - `version`: Module version
  - `repository`: Git URL, zip/tar URL, or local path
  - `tags` (optional): Keywords for search

## CLI Reference

### Module Management (`lola mod`)

| Command | Description |
|---------|-------------|
| `lola mod add <source>` | Add a module from git, folder, zip, or tar |
| `lola mod ls` | List registered modules |
| `lola mod info <name>` | Show module details |
| `lola mod search <query>` | Search for modules across enabled marketplaces |
| `lola mod init [name]` | Initialize a new module |
| `lola mod init [name] -c` | Initialize with a command template |
| `lola mod update [name]` | Update module(s) from source |
| `lola mod rm <name>` | Remove a module |

### Marketplace Management (`lola market`)

| Command | Description |
|---------|-------------|
| `lola market add <name> <url>` | Register a marketplace from URL or local path |
| `lola market ls` | List all registered marketplaces |
| `lola market update [name]` | Update marketplace cache (or all if no name) |
| `lola market set --enable <name>` | Enable a marketplace for search and install |
| `lola market set --disable <name>` | Disable a marketplace (keeps it registered) |
| `lola market rm <name>` | Remove a marketplace |

### Installation

| Command | Description |
|---------|-------------|
| `lola install <module>` | Install skills and commands to all assistants |
| `lola install <module> -a <assistant>` | Install to specific assistant |
| `lola install <module> <path>` | Install to a specific project directory |
| `lola install <module> --scope user` | Install globally to user configuration directories |
| `lola uninstall <module>` | Uninstall skills and commands |
| `lola uninstall <module> --scope user` | Uninstall from user configuration directories |
| `lola installed` | List all installations |
| `lola update` | Regenerate assistant files |

#### Installation Scopes

Lola supports two installation scopes:

- **Project scope** (default): Installs to project directories (`.claude/`, `.cursor/`, `.opencode/`, etc.)
- **User scope**: Installs globally to user configuration directories

**User scope locations:**
- **Linux/Unix**: `~/.config/opencode/`, `~/.claude/`, `~/.cursor/`
- **macOS**: `~/.config/opencode/`, `~/.claude/`, `~/.cursor/`
- **Windows**: `~/.config/opencode/`, `~/.claude/`, `~/.cursor/`

Examples:
```bash
# Install to current project (default)
lola install my-module

# Install globally for your user  
lola install my-module --scope user

# Install to specific project
lola install my-module /path/to/project
```

## Creating a Module

### 1. Initialize

```bash
lola mod init my-skills
cd my-skills
```

This creates:

```
my-skills/
  skills/
    example-skill/
      SKILL.md         # Initial skill (unless --no-skill)
  commands/            # Created by default
    example-command.md # (unless --no-command)
  agents/              # Created by default
    example-agent.md   # (unless --no-agent)
```

### 2. Edit the skill

Edit `skills/example-skill/SKILL.md`:

```markdown
---
name: my-skills
description: Description shown in skill listings
---

# My Skill

Instructions for the AI assistant...
```

### 3. Add supporting files to skills

You can add additional files to any skill directory (scripts, templates, examples, etc.). Reference them using relative paths in your `SKILL.md`:

```markdown
# My Skill

Use the helper script: `./scripts/helper.sh`

Load the template from: `./templates/example.md`
```

**Path handling:** Use relative paths like `./file` or `./scripts/helper.sh` to reference files in the same skill directory. Each assistant handles these differently:

| Assistant | Skill Location | Supporting Files | Path Behavior |
|-----------|---------------|------------------|---------------|
| Claude Code | `.claude/skills/<skill>/SKILL.md` | Copied with skill | Paths work as-is |
| Cursor | `.cursor/rules/<skill>.mdc` | Stay in `.lola/modules/` | Paths rewritten automatically |
| Gemini | `GEMINI.md` (references only) | Stay in `.lola/modules/` | Paths work (SKILL.md read from source) |
| OpenCode | `AGENTS.md` (references only) | Stay in `.lola/modules/` | Paths work (SKILL.md read from source) |

- **Claude Code** copies the entire skill directory, so relative paths like `./scripts/helper.sh` work because the files are alongside `SKILL.md`
- **Cursor** only copies the skill content to an `.mdc` file, so Lola rewrites `./` paths to point back to `.lola/modules/<module>/skills/<skill>/`
- **Gemini/OpenCode** don't copy skills—they add entries to `GEMINI.md`/`AGENTS.md` that tell the AI to read the original `SKILL.md` from `.lola/modules/`, so relative paths work from that location

Example skill structure:

```
my-skills/
  skills/
    example-skill/
      SKILL.md
      scripts/
        helper.sh
      templates/
        example.md
```

### 4. Add more skills

Create additional skill directories under `skills/`, each with a `SKILL.md`:

```
my-skills/
  skills/
    example-skill/
      SKILL.md
    git-workflow/
      SKILL.md
    code-review/
      SKILL.md
```

### 5. Add slash commands

Create a `commands/` directory with markdown files:

```
my-skills/
  skills/
    example-skill/
      SKILL.md
  commands/
    review-pr.md
    quick-commit.md
```

Command files use YAML frontmatter:

```markdown
---
description: Review a pull request
argument-hint: <pr-number>
---

Review PR #$ARGUMENTS and provide feedback.
```

> **Note:** Modules use auto-discovery. Skills, commands, and agents are automatically detected from the directory structure. No manifest file is required.

### 6. Add to registry and install

```bash
lola mod add ./my-skills
lola install my-skills
```

## Module Structure

```
my-module/
  skills/            # Skills directory
    skill-name/
      SKILL.md       # Required: skill definition
      scripts/       # Optional: supporting files
      templates/     # Optional: templates
  commands/          # Optional: slash commands
    review-pr.md
    quick-commit.md
  agents/            # Optional: subagents
    my-agent.md
```

> **Note:** Modules use auto-discovery. Skills are discovered from `skills/<name>/SKILL.md`, commands from `commands/*.md`, and agents from `agents/*.md`. No manifest file is required.

### SKILL.md

```markdown
---
name: skill-name
description: When to use this skill
---

# Skill Title

Your instructions, workflows, and guidance for the AI assistant.

Reference supporting files using relative paths:
- `./scripts/helper.sh` - files in the same skill directory
- `./templates/example.md` - subdirectories are supported
```

**Supporting files:** You can include scripts, templates, examples, or any other files in your skill directory. Use relative paths like `./file` or `./scripts/helper.sh` in your `SKILL.md` to reference them. These paths are automatically rewritten for different assistant types during installation.

### Command Files

```markdown
---
description: What this command does
argument-hint: <required> [optional]
---

Your prompt template here. Use $ARGUMENTS for all args or $1, $2 for positional.
```

**Argument variables:**
- `$ARGUMENTS` - All arguments as a single string
- `$1`, `$2`, `$3`... - Positional arguments

Commands are automatically converted to each assistant's format:
- Claude/Cursor: Markdown with frontmatter (pass-through)
- Gemini: TOML with `{{args}}` substitution

## How It Works

1. **Marketplaces**: Register catalogs at `~/.lola/market/` with cached data at `~/.lola/market/cache/`
2. **Discovery**: Search across enabled marketplace caches to find modules
3. **Registry**: Modules are stored in `~/.lola/modules/`
4. **Installation**: Skills and commands are converted to each assistant's native format
5. **Prefixing**: Skills and commands are prefixed with module name to avoid conflicts (e.g., `mymodule-skill`)
6. **Scopes**: 
   - **Project scope** (default): Copies modules to `.lola/modules/` within the project
   - **User scope**: Installs globally to platform-appropriate user config directories
7. **Updates**: `lola mod update` re-fetches from original source; `lola update` regenerates files; `lola market update` refreshes marketplace caches

## Code of Conduct

This project follows the [Contributor Covenant Code of Conduct v2.1](CODE_OF_CONDUCT.md).

## Security

For reporting vulnerabilities, see [SECURITY.md](SECURITY.md).

## Contributing

Contributions are welcome! See [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines.

## Governance

Lola is governed by its maintainers. See [GOVERNANCE.md](GOVERNANCE.md) for the project's roles, decision-making process, and release cadence.

## Community

Join the community on Matrix: [#lola-ai:matrix.org](https://matrix.to/#/#lola-ai:matrix.org)

## License

[Apache-2.0](https://spdx.org/licenses/Apache-2.0.html)

## Authors

- Igor Brandao
- Katie Mulliken
