ALMFx

Application Lifecycle Management toolkit for SharePoint Framework (SPFx) and PnP provisioning — the same operations delivered as PowerShell, VS Code, and AI agent skills.

Status: early scaffolding. Nothing is published yet.

What you can install

Format	What it is	Status
PowerShell module ALMFx	Cmdlets for app catalog, package deployment, app upgrade, tenant inventory	Skeleton — builds and imports, no ALM cmdlets yet
VS Code extension	SPFx ALM operations from the editor	Scaffold — compiles, one placeholder command
Standalone scripts	Single-file .ps1 for people who cannot install modules	Not started
Agent skills	Claude Code plugin that drives ALMFx	Deliberately empty until there is something to drive
Reference docs	SPFx ALM and PnP provisioning domain knowledge	Written — the repo's single source of truth

Reference documentation

Even before ALMFx does anything, docs/reference/spfx-alm/ is useful on its own: verified PnP cmdlets, deployment and upgrade procedures, API permission handling, provisioning, and failure triage — every cmdlet checked against the PnP documentation source rather than recalled.

Quick start

# PowerShell 7.4+
Install-Module ALMFx -Scope CurrentUser      # once published
Import-Module ALMFx
Get-Command -Module ALMFx

# Claude Code — once published
/plugin marketplace add marat-365/ALMFx
/plugin install almfx@almfx

Repository layout

docs/reference/spfx-alm/  Domain knowledge — single source of truth
src/powershell/ALMFx/     PowerShell module (one function per file)
src/vscode/almfx/         VS Code extension
scripts/                  Standalone .ps1 — no install required
plugins/almfx/skills/     Skills shipped to users (empty for now)
.claude/skills/           Skills for agents working ON this repo
tests/Pester/             Pester 5 tests (all network calls mocked)
build/                    Build, analyze, test, publish
docs/adr/                 Architecture decisions
samples/                  Example templates and configurations

Full detail: docs/repo-structure.md.

Working with AI assistants

This repo is configured for Claude Code, GitHub Copilot, and any agent that reads AGENTS.md:

• AGENTS.md — canonical rules, edit this one
• CLAUDE.md — imports AGENTS.md, adds Claude-specific notes
• .github/copilot-instructions.md — Copilot Chat & code review
• .github/instructions/ — path-scoped rules (applyTo)
• .github/prompts/ — reusable Copilot prompt files
• .claude/skills/ — repo-development skills

Domain facts belong in docs/reference/spfx-alm/, never duplicated into a skill, a function's help, or extension copy.

Requirements

• PowerShell 7.4+ (matching PnP.PowerShell v3)
• PnP.PowerShell 3.x
• SharePoint Administrator or site collection App Catalog rights, depending on the operation

Contributing

See CONTRIBUTING.md.

Licence

MIT — see LICENSE and docs/licensing.md for why, and how it lines up with PnP and the SPFx community projects.