npm - @tonycasey/lisa - Versions diffs - 1.2.0 → 2.0.0 - Mend

@tonycasey/lisa 1.2.0 → 2.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (565) hide show

package/dist/templates/agents/docs/EXTENDING-SKILLS.md DELETED Viewed

@@ -1,291 +0,0 @@
-# Extending Skills
-This guide explains how to extend Lisa's built-in skills with company-specific workflows without modifying the base skill files.
-## Overview
-Skills can be extended using `SKILL.local.md` files. These files:
-- Are preserved when Lisa is updated
-- Are merged with the base `SKILL.md` at build time
-- Allow you to add company-specific workflows, scripts, and documentation
-## Quick Start
-### 1. Create a Local Extension
-Create a `SKILL.local.md` file in the skill directory you want to extend:
-```bash
-# Extend the git skill
-touch .agents/skills/git/SKILL.local.md
-```
-### 2. Add Your Extensions
-```markdown
----
-extends: git
----
-## Company Git Workflow
-### Pre-push Checklist
-1. Run security scan: `npm run security`
-2. Update changelog
-3. Bump version
-### Deploy to Staging
-\`\`\`bash
-./scripts/deploy-staging.sh
-\`\`\`
-```
-### 3. Compile to Apply
-Ask Lisa to compile the skills:
-```
-lisa, compile skills
-```
-Or run the script directly:
-```bash
-node .agents/skills/lisa/scripts/compile-skills.js
-```
-The `SKILL.local.md` content will be merged into `SKILL.md`.
-**Note:** Skill extensions are also automatically merged when:
-- The Lisa package is installed or updated (`npm install`)
-- You explicitly ask Lisa to compile skills
-## File Structure
-```
-.agents/skills/git/
-├── SKILL.md           # Base skill (from Lisa package)
-├── SKILL.local.md     # Your extensions (preserved on updates)
-└── scripts/
-    ├── bump-version.js     # Base scripts
-    └── company-deploy.js   # Your custom scripts
-```
-## SKILL.local.md Format
-### Frontmatter
-```yaml
----
-extends: skill-name        # Required: name of the skill being extended
-description: "Additional triggers"  # Optional: appended to base description
----
-```
-### Body
-Add any markdown content. Common sections:
-- Custom workflows
-- Company-specific commands
-- Integration instructions
-- Environment setup
-## Example: Extending the Git Skill
-### .agents/skills/git/SKILL.local.md
-```markdown
----
-extends: git
-description: "Also triggers on 'deploy', 'release'."
----
-## Company Release Process
-### Pre-release Checklist
-Before creating a release:
-1. **Update version**
-   \`\`\`bash
-   node .agents/skills/git/scripts/bump-version.js minor
-   \`\`\`
-2. **Run security audit**
-   \`\`\`bash
-   npm audit --production
-   \`\`\`
-3. **Update CHANGELOG.md**
-   \`\`\`bash
-   npx conventional-changelog -p angular -i CHANGELOG.md -s
-   \`\`\`
-### Deploy to Production
-\`\`\`bash
-# Tag and push
-git tag -a "v$(node -p "require('./package.json').version")" -m "Release"
-git push origin --tags
-# Deploy via CI
-gh workflow run deploy.yml
-\`\`\`
-### Rollback Procedure
-If deployment fails:
-\`\`\`bash
-# Revert to previous tag
-git checkout tags/v1.2.3
-./scripts/emergency-deploy.sh
-\`\`\`
-```
-## Adding Custom Scripts
-You can add custom scripts alongside the base scripts:
-```
-.agents/skills/git/scripts/
-├── bump-version.js        # Base (from Lisa)
-├── poll-ci.sh             # Base (from Lisa)
-├── company-deploy.js      # Custom (yours)
-└── security-scan.js       # Custom (yours)
-```
-Custom scripts are preserved during Lisa updates if placed in:
-- The `scripts/` directory (alongside base scripts)
-- A `.local/` directory (e.g., `scripts.local/`)
-## How Merging Works
-When Lisa is installed/updated or you run "lisa, compile skills":
-1. **Preserve**: `SKILL.local.md` files are saved during package update
-2. **Deploy**: Base templates are copied to `.agents/`
-3. **Restore**: `SKILL.local.md` files are restored
-4. **Merge**: Local content is appended to base `SKILL.md`
-### Merge Result
-**Base SKILL.md:**
-```markdown
----
-name: git
-description: "GitHub workflow helpers"
----
-## How to use
-...base content...
-```
-**SKILL.local.md:**
-```markdown
----
-extends: git
----
-## Company Workflow
-...your content...
-```
-**Merged SKILL.md:**
-```markdown
----
-name: "git"
-description: "GitHub workflow helpers"
----
-## How to use
-...base content...
-<!-- Local Extensions (from SKILL.local.md) -->
-## Company Workflow
-...your content...
-```
-## Best Practices
-### Do
-- ✅ Use `SKILL.local.md` for company-specific workflows
-- ✅ Add custom scripts to the `scripts/` directory
-- ✅ Document your extensions clearly
-- ✅ Include examples and commands
-- ✅ Reference base skill sections when relevant
-### Don't
-- ❌ Modify base `SKILL.md` directly (changes will be overwritten)
-- ❌ Duplicate content from the base skill
-- ❌ Remove base functionality
-- ❌ Use conflicting section names
-## Extending Other Skills
-The same pattern works for any skill:
-| Skill | Extension File |
-|-------|----------------|
-| git | `.agents/skills/git/SKILL.local.md` |
-| memory | `.agents/skills/memory/SKILL.local.md` |
-| tasks | `.agents/skills/tasks/SKILL.local.md` |
-| jira | `.agents/skills/jira/SKILL.local.md` |
-## Troubleshooting
-### Extension not appearing
-1. Ensure file is named exactly `SKILL.local.md` (case-sensitive)
-2. Ask "lisa, compile skills" to trigger the merge
-3. Check the merged `SKILL.md` for your content
-### Extension overwritten
-1. Ensure your file has `.local.md` extension
-2. Check that the `extends:` frontmatter matches the skill name
-3. Local files should never be overwritten during updates
-### Merge conflicts
-The merge process appends local content; it doesn't try to merge sections. If you need to override a specific section, copy it to your local file with modifications.
-## Version Control
-### .gitignore
-```gitignore
-# Ignore base skills (they come from Lisa package)
-.agents/skills/*/SKILL.md
-# But track local extensions
-!.agents/skills/*/SKILL.local.md
-```
-### Committing Extensions
-```bash
-# Add your local extensions
-git add .agents/skills/*/SKILL.local.md
-git add .agents/skills/*/scripts/company-*.js
-git commit -m "feat: add company git workflow extensions"
-```
-## Migration from Modified Base Files
-If you've modified base `SKILL.md` files directly:
-1. Copy your custom sections to a new `SKILL.local.md`
-2. Remove the `---` frontmatter (or use `extends:`)
-3. Ask "lisa, compile skills" to merge local extensions
-4. Verify the merged result
-```bash
-# Example: migrate git skill customizations
-cp .agents/skills/git/SKILL.md .agents/skills/git/SKILL.local.md.bak
-# Edit SKILL.local.md to keep only your custom sections
-# Add extends: git frontmatter
-# Then ask: "lisa, compile skills"
-```

package/dist/templates/agents/docs/EXTENDING-rules.md DELETED Viewed

@@ -1,57 +0,0 @@
-# Local Extensions
-This project supports local rule and skill extensions that persist across package updates.
-## How Local Extensions Work
-When loading any rule file (e.g., `git-rules.md`), **always check if a corresponding `.local.md` file exists** (e.g., `git-rules.local.md`). If it exists, apply both files with the local file taking precedence.
-## Extension Pattern
-Local files use inheritance semantics:
-- **Inherits**: All sections from the base file apply unless overridden
-- **Override**: A section with the same name in the local file replaces the base section
-- **Extend**: New sections in the local file add to the base rules
-## File Naming Convention
-| Base File | Local Extension |
-|-----------|-----------------|
-| `git-rules.md` | `git-rules.local.md` |
-| `coding-standards.md` | `coding-standards.local.md` |
-| `testing-principles.md` | `testing-principles.local.md` |
-## Local File Format
-Local extension files should include:
-1. A title indicating it's a local extension
-2. An `> Extends:` directive referencing the base file
-3. Sections that override or extend the base
-### Example: `git-rules.local.md`
-```markdown
-# Git Rules (Local Extensions)
-> Extends: git-rules.md
-## Commit Messages (Override)
-- Use format: `[JIRA-123] type: description`
-- All commits MUST reference a Jira ticket
-## Branch Naming (New Section)
-- Feature branches: `feature/JIRA-123-description`
-- Bugfix branches: `bugfix/JIRA-123-description`
-```
-## For Skills
-Custom skills use a `.local.md` file name suffix too:
-## Important
-- Local files are **preserved** during package updates
-- Local files are **not** created automatically - users create them manually when needed
-- Always apply local extensions when they exist

package/dist/templates/agents/docs/STORAGE_SETUP.md DELETED Viewed

@@ -1,161 +0,0 @@
-# Storage Setup Guide
-## Overview
-Lisa uses a graph database (Neo4j) to store persistent memory. This enables Lisa to remember context across sessions, track project history, and provide intelligent assistance based on past interactions.
-There are three storage options available:
-| Option | Best For | Requirements |
-|--------|----------|--------------|
-| **Local Docker** | Development, testing | Docker Desktop |
-| **Zep Cloud** | Managed service, easiest setup | Zep Cloud account |
----
-## Option 1: Local Docker (Recommended for Development)
-Run Neo4j and the Zep (Graphiti) MCP server locally using Docker.
-### Prerequisites
-- Docker Desktop installed and running
-- At least 4GB RAM available for containers
-### Setup Steps
-1. **Initialize with local mode:**
-   ```bash
-   lisa init --mode local
-   ```
-2. **Start the services:**
-   ```bash
-   lisa up
-   ```
-3. **Verify the connection:**
-   ```bash
-   lisa doctor
-   ```
-### What Gets Started
-- **Neo4j** - Graph database on port 7474 (browser) and 7687 (bolt)
-- **MCP Server** - Memory API on port 8010
-### Stopping Services
-```bash
-lisa down
-```
----
-## Option 2: Zep Cloud (Fully Managed)
-Use Zep's managed service for production.
-### Prerequisites
-- Zep Cloud account (sign up at [getzep.com](https://getzep.com))
-### Setup Steps
-1. **Create a Zep project:**
-   - Go to [cloud.getzep.com](https://cloud.getzep.com)
-   - Create a new project
-   - Copy your API key (starts with `z_`)
-2. **Initialize with zep-cloud mode:**
-   ```bash
-   lisa init --mode zep-cloud
-   ```
-3. **Enter Zep API key when prompted**
-4. **Verify the connection:**
-   ```bash
-   lisa doctor
-   ```
-### How It Works
-- **No Docker required** - Lisa connects directly to Zep's REST API
-- **No MCP server** - Uses Zep's native `/api/v2` endpoints
-- **Free tier** - 1,000 episodes/month, unlimited storage
----
-## Manual Configuration
-If you chose "Set up later" during initialization, follow these steps:
-1. **Edit the environment file:**
-   ```bash
-   nano .agents/.env
-   ```
-2. **Uncomment and configure your chosen option:**
-   **For Local Docker:**
-   ```env
-   STORAGE_MODE=local
-   GRAPHITI_ENDPOINT=http://localhost:8010/mcp/
-   GRAPHITI_GROUP_ID=your-project-name
-   ```
-    **For Zep Cloud:**
-   ```env
-   STORAGE_MODE=zep-cloud
-   GRAPHITI_GROUP_ID=your-project-name
-   ZEP_API_KEY=z_xxxxx
-   ```
-   Note: No endpoint needed - Lisa uses Zep's native REST API directly.
-3. **Start a new terminal session** (to load new environment variables)
-4. **Run `lisa doctor`** to verify the connection
----
-## Environment Variables Reference
-| Variable | Mode | Description |
-|----------|------|-------------|
-| `STORAGE_MODE` | all | Storage mode: `local`, `zep-cloud`, or `skip` |
-| `GRAPHITI_ENDPOINT` | local | MCP server endpoint URL (not needed for zep-cloud) |
-| `GRAPHITI_GROUP_ID` | all | Memory group identifier (usually project name) |
-| `ZEP_API_KEY` | zep-cloud | Zep Cloud API key (starts with `z_`) |
----
-## Commands Reference
-| Command | Description |
-|---------|-------------|
-| `lisa init` | Initialize Lisa in a project |
-| `lisa up` | Start local Docker services |
-| `lisa down` | Stop local Docker services |
-| `lisa doctor` | Check storage connection status |
----
-## Troubleshooting
-### `lisa doctor` shows "Docker missing or not running"
-- Ensure Docker Desktop is installed and running
-- On macOS: Check the Docker icon in the menu bar
-- On Linux: Run `sudo systemctl start docker`
-### "MCP check failed" error
-- Verify the endpoint URL is correct
-- For local mode: Ensure `lisa up` has been run
-- Check that port 8010 is not blocked by firewall
-### "Invalid API key" (Zep Cloud)
-- Verify the API key is correct
-- Check the project ID matches your Zep project
-- Ensure your Zep account is active
----
-## Getting Help
-- Run `lisa --help` for command options
-- Check [github.com/TonyCasey/lisa](https://github.com/TonyCasey/lisa) for updates
-- Report issues at the GitHub repository

package/dist/templates/agents/skills/git/scripts/bump-version.js DELETED Viewed

@@ -1,112 +0,0 @@
-#!/usr/bin/env node
-"use strict";
-/**
- * Version Bump Script
- *
- * Bumps version in package.json based on semver rules.
- * Usage: node bump-version.js [major|minor|patch]
- *
- * Default: minor
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-const fs = require('fs');
-const path = require('path');
-/**
- * Find package.json in current directory or parent directories
- */
-function findPackageJson(startDir = process.cwd()) {
-    let dir = startDir;
-    while (dir !== path.parse(dir).root) {
-        const pkgPath = path.join(dir, 'package.json');
-        if (fs.existsSync(pkgPath)) {
-            return pkgPath;
-        }
-        dir = path.dirname(dir);
-    }
-    return null;
-}
-/**
- * Parse semver version string
- */
-function parseVersion(version) {
-    const match = version.match(/^(\d+)\.(\d+)\.(\d+)(-.*)?$/);
-    if (!match) {
-        throw new Error(`Invalid version format: ${version}`);
-    }
-    return {
-        major: parseInt(match[1], 10),
-        minor: parseInt(match[2], 10),
-        patch: parseInt(match[3], 10),
-        prerelease: match[4] || '',
-    };
-}
-/**
- * Bump version based on type
- */
-function bumpVersion(version, type = 'minor') {
-    const parsed = parseVersion(version);
-    switch (type) {
-        case 'major':
-            parsed.major += 1;
-            parsed.minor = 0;
-            parsed.patch = 0;
-            break;
-        case 'minor':
-            parsed.minor += 1;
-            parsed.patch = 0;
-            break;
-        case 'patch':
-            parsed.patch += 1;
-            break;
-        default:
-            throw new Error(`Unknown bump type: ${type}. Use major, minor, or patch.`);
-    }
-    // Drop prerelease suffix on bump
-    return `${parsed.major}.${parsed.minor}.${parsed.patch}`;
-}
-/**
- * Validate bump type argument
- */
-function validateBumpType(arg) {
-    if (arg === 'major' || arg === 'minor' || arg === 'patch') {
-        return arg;
-    }
-    throw new Error(`Invalid bump type "${arg}". Use: major, minor, or patch`);
-}
-async function main() {
-    const bumpType = validateBumpType(process.argv[2] || 'minor');
-    // Find package.json
-    const pkgPath = findPackageJson();
-    if (!pkgPath) {
-        console.error('Error: package.json not found');
-        process.exit(1);
-    }
-    // Read and parse package.json
-    const pkgContent = fs.readFileSync(pkgPath, 'utf8');
-    const pkg = JSON.parse(pkgContent);
-    if (!pkg.version) {
-        console.error('Error: No version field in package.json');
-        process.exit(1);
-    }
-    const oldVersion = pkg.version;
-    const newVersion = bumpVersion(oldVersion, bumpType);
-    // Update package.json
-    pkg.version = newVersion;
-    // Write back with same formatting (2-space indent)
-    fs.writeFileSync(pkgPath, JSON.stringify(pkg, null, 2) + '\n');
-    // Output for scripting (JSON to stdout)
-    const result = {
-        status: 'ok',
-        bumpType,
-        oldVersion,
-        newVersion,
-        file: pkgPath,
-    };
-    console.log(JSON.stringify(result));
-    // Also output human-readable to stderr
-    console.error(`Bumped version: ${oldVersion} → ${newVersion} (${bumpType})`);
-}
-main().catch((err) => {
-    console.error(`Error: ${err.message}`);
-    process.exit(1);
-});