@leed-ai/cli 0.0.0-stage → 6.19.0

package/LICENSE.md

@@ -0,0 +1,57 @@
+# License Information
+
+This software is licensed under the terms of the End User License Agreement (EULA) provided by Leed, Inc.
+
+## SPDX Identifier
+
+The source files in this project include the following SPDX license identifier:
+
+* **SPDX-License-Identifier:** LicenseRef-Leed-EULA
+
+### Explanation
+
+> **LicenseRef-Leed-EULA**: This identifier refers to the proprietary license agreement specific to this software. It is not part of the standard SPDX License List but is defined here to indicate compliance with our custom licensing terms.
+
+## End User License Agreement (EULA)
+
+This End User License Agreement ("Agreement") is a legal agreement between you ("User") and Leed, Inc. ("Company") for the use of Site Management Application ("Software"). By installing or using the Software, you agree to be bound by the terms of this Agreement.
+
+1. **License Grant**
+
+    Leed, Inc. grants you a non-exclusive, non-transferable license to install and use the Software on any number devices for business purposes, subject to the terms of this Agreement.
+
+1. **Restrictions**
+
+   * You may not copy, modify, distribute, sell, or lease any part of the Software.
+   * You may not reverse engineer or attempt to extract the source code of the Software.
+   * You may not use the Software for any unlawful purposes.
+
+1. **Ownership**
+
+    The Software is licensed, not sold. Leed, Inc. retains all rights, title, and interest in and to the Software, including all intellectual property rights.
+
+1. **Termination**
+
+    This Agreement is effective until terminated. Your rights under this Agreement will terminate automatically without notice if you fail to comply with any term(s) of this Agreement. Upon termination, you must cease all use of the Software and destroy all copies.
+
+1. **License Duration and Termination**
+
+   * The Software is licensed for use only while under a valid, active license agreement. The license is effective upon payment and activation and will remain in effect until the specified expiration date.
+   * Upon expiration of the license, your rights to use the Software will immediately cease. You must uninstall and delete all copies of the Software from your devices.
+   * Failure to comply with this requirement may result in legal action for unauthorized use of the Software.
+
+1. **Disclaimer of Warranties**
+
+    The Software is provided "as is" without warranty of any kind. Leed, Inc. disclaims all warranties, express or implied, including but not limited to the implied warranties of merchantability and fitness for a particular purpose.
+
+1. **Limitation of Liability**
+
+    In no event shall Leed, Inc. be liable for any special, incidental, indirect, or consequential damages whatsoever arising out of the use of or inability to use the Software.
+
+1. **Governing Law**
+
+    This Agreement shall be governed by and construed in accordance with the laws of [Your State/Country], without regard to its conflict of law principles.
+
+1. **Entire Agreement**
+
+    This Agreement constitutes the entire agreement between you and Leed, Inc. with respect to the Software and supersedes all prior or contemporaneous understandings regarding such subject matter.

package/README.md

@@ -1,3 +1,126 @@
-# Temporary Holding Version
+# Leed CLI
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+`@leed-ai/cli` installs the `leed` command: local development, preview and publishing for websites built on [Leed](https://leed.ai).
+
+## Install
+
+```bash
+npm i -g @leed-ai/cli
+# or
+bun i -g @leed-ai/cli
+```
+
+No access token or registry configuration is needed: the package is on the public npm registry.
+
+Then turn on shell tab completion (bash, zsh or fish). The package runs no install scripts, so a manual install does not do this for you; the one-line installer below and `/leed:setup` run it after installing:
+
+```bash
+leed completion install
+```
+
+Requirements:
+
+- **Bun.** `leed` runs on Bun (`#!/usr/bin/env bun`), whichever package manager installed it. Get it from [bun.sh](https://bun.sh).
+- **Node 22 or newer.**
+- **git 2.31 or newer.** The content repository access token is supplied to git through its config environment variables (`GIT_CONFIG_COUNT`), which git gained in 2.31; an older git ignores them silently and every authenticated operation fails as if no credential had been given.
+
+Most people never run the install by hand: the one-line installer at `https://app.leed.ai/install` installs Bun if needed (only after a yes at a terminal), the CLI and completion, and then runs `leed setup` for the environment it was served from, which signs you in and sets up your site. Without a terminal (CI, a pipe with no TTY) it stops after installing the CLI and prints the `leed setup` command to run.
+
+## First-time setup
+
+```bash
+leed setup --env production                 # sign in, choose the folder (default ~/leed), set the site up
+leed setup --env production --company acme.com  # reuse the saved login for that company
+leed setup --env production --new-login     # sign in again and choose another company
+leed setup --env production --json          # unattended: no prompts, defaults, one JSON document
+leed setup --env production --check --json  # only report what is left to do; changes nothing
+```
+
+`leed setup` works on exactly one environment, named by `--env` or `ENV_NAME`; it never falls back to a default or to a login saved for another environment, and it prints the environment and CMS URL before signing in. There is no default login, so it never picks a saved one on its own: `--company <companyId|domain>` names the saved login to reuse, and without it an environment holding company logins asks at a terminal which to use (or to sign in again), while `--json`, `--check` and a run with no terminal refuse with `invalid_arguments` and the exact `leed setup --env <env> --company <companyId>`. The chosen login is reused once the CMS accepts it; with none saved it signs in with the browser device flow where you choose the company. `--email` sends a magic link instead and stops: the link signs in your browser, so run `leed setup` again afterwards to finish signing the CLI in there. It then keeps a site already set up for that company, or runs `leed site init --dir <folder>` in the folder you choose (`--dir`, or a prompt defaulting to `~/leed`), installs Font Awesome Free, and sets up shell completion (as `leed completion install` does), reporting it in one line. At a terminal it then offers, once each, to write a VS Code workspace (the files `leed site vscode` writes, only those missing: an existing workspace or `.vscode/tasks.json` is kept) and to install the Leed plugin for Claude Code (`claude plugin install leed@leed`, checked with `claude plugin list --json`), or to enable it with `claude plugin enable leed@leed` when it is installed but disabled; a no is remembered in `~/.config/leed/preferences.json`, and neither is offered under `--json` or inside Claude Code. A saved login the CMS places in no company is offered a browser sign-in at a terminal, where the company is chosen; under `--json` it refuses with the hint `leed setup --env <env> --new-login`. For `dev`, every command it prints for you to run that reaches the CMS starts with `LEED_CMS_URL=<url>` (local ones such as `leed site list` are printed bare). Every step checks before it acts, so it is safe to run again; `--check` only reports what is left, and writes nothing (it does not even renew the saved login): a token past its expiry but still inside the CMS's renewal window is reported with a warning as renewable, and a login placed in no company as needing a sign-in, with the `--new-login` command.
+
+## Migrating from `@leed/site-management`
+
+The CLI used to be published privately as `@leed/site-management`. That package no longer receives updates. Replace it with:
+
+```bash
+bun remove -g @leed/site-management && npm i -g @leed-ai/cli
+```
+
+The `leed` command and every subcommand are unchanged. If your `~/.bunfig.toml` still has an `"@leed"` line under `[install.scopes]`, it was only there for the old package and can be deleted.
+
+## Sites on this machine
+
+`leed site init` records each site it sets up in one per-user registry, `$XDG_CONFIG_HOME/leed/sites.json` (default `~/.config/leed/sites.json`, beside `auth.json`, mode 600). A site checkout is the nearest folder holding `identity.json`, so every `leed site` command works from the checkout root or any folder inside it, wherever the folder lives; moving or renaming it needs no action, because the next command run inside it records the new path.
+
+```bash
+leed site list                     # every registered site and sandbox, with its checkouts (offline; --json too)
+leed site build --site acme.com    # any leed site command, from anywhere: by name, domain or companyId
+leed site init --company acme.com -e production --dir ~/sites  # set a site up in ~/sites/<site>/raw-content
+```
+
+The CLI never picks a site, company or environment you did not name. Outside every checkout a `leed site` command needs `--site`: without it, it refuses with `invalid_arguments`, listing the registered sites and the exact `--site` to pass, with one registered site as with several. Commands that act on a company (`leed settings`, `leed asset list|get|set|export`, `leed page`, `leed mcp add --cms`) take it from the checkout they run in, else from `--company` and `-e` (`-e` may be left out when that company is logged in to exactly one environment); `leed auth login` and `leed auth logout` need `-e` outside a checkout (or `--company`, when that company is logged in to exactly one environment), and logout also `--company` whenever company sessions are stored. None falls back to a default login or to production. `leed site list` and `leed auth status` list everything, each row with its environment. CI and unregistered checkouts run in direct mode as before: `identity.json` plus environment variables, and no registry at all. A `leed.config.json` left by an older CLI is imported into the registry the first time the CLI meets it, with a one-time notice, and is never read again.
+
+## Build a site
+
+If installed globally: `leed site build -c CUSTOMER_NAME -l LOCATION_OF_CUSTOMER_REPOS`
+
+If running from the development environment: `./BuildSite -c CUSTOMER_NAME -l LOCATION_OF_CUSTOMER_REPOS`
+
+To build a customer site and a live server add `--serve`. To exit serve mode press: `<ctrl-c>` in your terminal.
+
+Some parameters that might be helpful that can be passed to the site builder:
+
+- `-v` produces verbose output for for `leed:*`
+- `-n` "leed:*" ... supports patterns to reduce output
+- `-p` builds a preview-site (when running watch build this is the default)
+- `-d` debug mode, does not minify the files on output for easier debugging. Also prevents stomping on the destination functions so that wrangler can run without crashing.
+
+All the files which are temporarily created in the raw content repository by the build process are listed in its .gitignore.
+
+### Output
+
+Site is rendered into `${LOCATION_OF_CUSTOMER_REPOS}/${CUSTOMER_NAME}/[public|preview]-site/site`
+
+### Font Awesome
+
+The build downloads no Font Awesome. A site has Font Awesome Free by default and installs it once, from its checkout:
+
+- `leed site init --font-awesome` installs Free 7.3.1 when no Font Awesome fonts are installed (never over Pro).
+- `leed site init --font-awesome-pro <zip>` installs or upgrades the site owner's own Pro fonts from their Pro web package zip (Pro 7.0.0 and 7.3.1 are supported).
+
+The Leed CI build (`.ci/build.sh`) runs `leed site init --font-awesome` before `leed site build`, so a site that has never committed fonts is built with Free; the fonts are installed for that build only and never committed. A site with its own fonts committed (its Pro, or Free) is left untouched, and a failed Free download fails the build, so the live site is never replaced by one with empty icons.
+
+The build reads `src/static/webfonts/fa-version.txt` (`free 7.3.1`, `pro 7.3.1`, or a bare version meaning Pro) and compiles against the matching `static/tailwind/font-awesome/<edition>-<version>.css`; with no file it uses Free. Set `LEED_FONT_AWESOME_BASE_URL` to a `file://` directory or `http://localhost` server to test the Free download locally. Converting a new Font Awesome release is described in `scripts/font-awesome/README.md`.
+
+## Sandbox sites
+
+`leed site init --sandbox [dir]` writes a local site into `dir` (default `./leed-sandbox`) from the fixture set in `static/templates/sandbox/`, with no Leed account and no git repository, then installs Font Awesome Free into it with the `--font-awesome` installer (`installFontAwesome` in `src/cli/fontAwesomeInstall.ts`, honoring `LEED_FONT_AWESOME_BASE_URL`). The fixture set carries no fonts. The download is best effort: offline, the sandbox is still written and the result carries a warning naming `leed site init --font-awesome` as the retry. It builds and previews with `leed site build [--serve]` like any site. Its `identity.json` names the company `non-cms-company`, which no real company can be, and every record id in it is a `ph-<kind>-<n>` placeholder.
+
+The template trees under `static/templates/` (`raw-content/`, `sandbox/`) store the site's `.gitignore` as `_gitignore`, because `npm pack` and `bun pm pack` drop every file named `.gitignore` from the published package. Every consumer that writes a tree into a site renames it back: `copyTemplateTree` (`src/utils/templateTree.ts`) for the sandbox init, and `templateTargetPath` (`libs/data-types/src/templateFiles.ts`) for the CMS template plant, the managed-files update and the dev seeder. Add a new dotfile to a template the same way, by listing its stored name in `PACKED_TEMPLATE_NAMES`.
+
+Every command that needs the CMS refuses in a sandbox with the error code `sandbox_site` (exit `3`) before it authenticates; the classification is `SANDBOX_COMMANDS` in `src/cli/sandbox/sandboxGuard.ts`, and a test requires every registered command to appear in it. The plugin's `/leed:site-sandbox-move` skill moves a sandbox into a real site. The code is in `src/cli/sandbox/`.
+
+## Git Permissions for the Personal Access Token
+
+| Operation                           | Level      |
+| ----------------------------------- | ---------- |
+| reading (git fetch, git clone etc.) | Reporter   |
+| writing (git push)                  | Developer  |
+| writing to protected branch         | Maintainer |
+
+## Development Notes
+
+User README.md is managed in the Templates / raw-content / README.md file. This gets put into their raw-content repos automatically.
+
+Tailwind v4 support is in place. This is a breaking change and will cause an upgrade from v3 of this tool to v4.
+
+We have pegged the fingerprintjs library because the next version changes the license from MIT to a business pay to use license.
+
+CI publishes every build to public npm through trusted publishing: staging builds under the `staging` dist-tag, and a release by moving `release` and `latest` onto a staging build. See `.claude/packages.md` in the monorepo.
+
+[Pagination Documentation](https://www.11ty.dev/docs/pagination/)
+[Pagination Navigation Documentation](https://www.11ty.dev/docs/pagination/nav/)
+
+## License
+
+See LICENSE.md

package/dist/LICENSE.md

@@ -0,0 +1,57 @@
+# License Information
+
+This software is licensed under the terms of the End User License Agreement (EULA) provided by Leed, Inc.
+
+## SPDX Identifier
+
+The source files in this project include the following SPDX license identifier:
+
+* **SPDX-License-Identifier:** LicenseRef-Leed-EULA
+
+### Explanation
+
+> **LicenseRef-Leed-EULA**: This identifier refers to the proprietary license agreement specific to this software. It is not part of the standard SPDX License List but is defined here to indicate compliance with our custom licensing terms.
+
+## End User License Agreement (EULA)
+
+This End User License Agreement ("Agreement") is a legal agreement between you ("User") and Leed, Inc. ("Company") for the use of Site Management Application ("Software"). By installing or using the Software, you agree to be bound by the terms of this Agreement.
+
+1. **License Grant**
+
+    Leed, Inc. grants you a non-exclusive, non-transferable license to install and use the Software on any number devices for business purposes, subject to the terms of this Agreement.
+
+1. **Restrictions**
+
+   * You may not copy, modify, distribute, sell, or lease any part of the Software.
+   * You may not reverse engineer or attempt to extract the source code of the Software.
+   * You may not use the Software for any unlawful purposes.
+
+1. **Ownership**
+
+    The Software is licensed, not sold. Leed, Inc. retains all rights, title, and interest in and to the Software, including all intellectual property rights.
+
+1. **Termination**
+
+    This Agreement is effective until terminated. Your rights under this Agreement will terminate automatically without notice if you fail to comply with any term(s) of this Agreement. Upon termination, you must cease all use of the Software and destroy all copies.
+
+1. **License Duration and Termination**
+
+   * The Software is licensed for use only while under a valid, active license agreement. The license is effective upon payment and activation and will remain in effect until the specified expiration date.
+   * Upon expiration of the license, your rights to use the Software will immediately cease. You must uninstall and delete all copies of the Software from your devices.
+   * Failure to comply with this requirement may result in legal action for unauthorized use of the Software.
+
+1. **Disclaimer of Warranties**
+
+    The Software is provided "as is" without warranty of any kind. Leed, Inc. disclaims all warranties, express or implied, including but not limited to the implied warranties of merchantability and fitness for a particular purpose.
+
+1. **Limitation of Liability**
+
+    In no event shall Leed, Inc. be liable for any special, incidental, indirect, or consequential damages whatsoever arising out of the use of or inability to use the Software.
+
+1. **Governing Law**
+
+    This Agreement shall be governed by and construed in accordance with the laws of [Your State/Country], without regard to its conflict of law principles.
+
+1. **Entire Agreement**
+
+    This Agreement constitutes the entire agreement between you and Leed, Inc. with respect to the Software and supersedes all prior or contemporaneous understandings regarding such subject matter.