diff --git a/skills/README.md b/skills/README.md index 388ca85..ec8831d 100644 --- a/skills/README.md +++ b/skills/README.md @@ -42,6 +42,7 @@ npx skills add CiscoDevNet/essentials --skill '*' --full-depth | [`ess/pr-address-comments-all`](ess/pr-address-comments-all/) | Address review comments across one or more PRs in parallel, each in its own git worktree on the PR's branch. | | [`ess/mcp-hide-secrets`](ess/mcp-hide-secrets/) | Move Cursor MCP credentials out of `mcp.json` into a login-loaded `mcp.env` (macOS LaunchAgent). | | [`ess/summarize-change-log`](ess/summarize-change-log/) | Condense a long git log or squash message into 1–5 Conventional-Commit bullets. | +| [`ess/essentials-sync`](ess/essentials-sync/) | Extract a jargon-free `ess-*` package out of a private tool and sync it to the open-source essentials repo. | ## Notes diff --git a/skills/ess/essentials-sync/LICENSE b/skills/ess/essentials-sync/LICENSE new file mode 100644 index 0000000..d645695 --- /dev/null +++ b/skills/ess/essentials-sync/LICENSE @@ -0,0 +1,202 @@ + + 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. diff --git a/skills/ess/essentials-sync/SKILL.md b/skills/ess/essentials-sync/SKILL.md new file mode 100644 index 0000000..5949d15 --- /dev/null +++ b/skills/ess/essentials-sync/SKILL.md @@ -0,0 +1,98 @@ +--- +name: essentials-sync +description: >- + Extract a jargon-free ess-* shared package out of a team- or account-specific + tool in a private repo and sync it to the open-source essentials repo, with + deterministic scanners and an adversarial LLM reviewer in between. Use when + the user runs /essentials-sync, asks to open-source a package, extract an + ess-* package, move or sync a tool into essentials, or scrub a package of + company jargon before publishing. Requires the essentials-sync CLI and a + CURSOR_API_KEY. +metadata: + version: "1.0" +--- + +# Essentials Sync + +Driver for the `essentials-sync` CLI. The CLI does the work — extraction, scanning (TruffleHog, secretlint, jargon, PII), the adversarial review loop, and all writes. This skill only resolves the binary and holds the approval gate, because a real run writes to **two** working trees. + +## Agent workflow (required) + +**Run only `scripts/run.sh`.** Do not invoke `essentials-sync` directly, do not hand-edit what it writes, and do not commit for the user. + +### 1. Preflight + +```bash +chmod +x scripts/run.sh +scripts/run.sh preflight +``` + +Stop and report if it fails. It checks Node >= 22, that the CLI resolves, and that `CURSOR_API_KEY` is set (or a `.env` is present for the CLI to load). A missing `trufflehog` is a warning, not a failure — that scanner is simply skipped. + +### 2. Resolve the arguments + +| Argument | Rule | +| --- | --- | +| `--source` | Absolute path. In default (extract) mode it must be a `tools/python//` directory inside the source repo. Ask if the user did not give one. | +| `--target-repo` | Absolute path to the essentials clone. Must be a git working tree. Ask if missing. | +| `--target-path` | Relative to `--target-repo`. Optional in extract mode (defaults to `packages/python/`), **required** with `--no-extract`. | + +If the source is already generic and needs no extraction, add `--no-extract` — and then `--target-path` is mandatory. + +### 3. Dry run + +```bash +scripts/run.sh dry-run --source --target-repo [...] +``` + +The CLI stages everything into a temp directory instead of the real target. + +### 4. GATE — wait for approval + +Show the user the resolved command, the CLI's `[plan]`, `[source-scan]`, and `[models]` lines, and the dry-run outcome. **Do not proceed until they explicitly approve.** + +### 5. Sync + +```bash +scripts/run.sh sync --source --target-repo [...] +``` + +### 6. Report + +State the exit code and run `git status` in both repos (the CLI prints the exact commands on success). Both trees are left dirty on purpose — the user reviews and commits. + +Never echo scanner findings that quote a secret value; report the file and rule instead. + +## Options worth knowing + +| Option | Use it when | +| --- | --- | +| `--no-extract` | The source is already generic; runs the sync phase only. Pair with `--target-path`. | +| `--no-fast-copy` | Force the agent to author the sync even when a clean source would qualify for a verbatim copy. | +| `--package-name ` | The derived `ess-` name is wrong. Must be kebab-case and start with `ess-`. | +| `--max-revisions ` | Default 3 scan-and-revise iterations per phase. | +| `--no-adversarial-review` | Deterministic scanners only; skips the LLM reviewer. | +| `--model` / `--review-model` | Override the `opus` / `codex` family sentinels. | +| `--list-models` | Print the model IDs available to the current API key. | + +Full option table, jargon wordlist customization (`.essentials-sync-jargon.json`), and install troubleshooting: [tools/typescript/essentials-sync/README.md](https://github.com/CiscoDevNet/essentials/blob/main/tools/typescript/essentials-sync/README.md). + +## Exit codes + +| Code | Meaning | +| --- | --- | +| 0 | Both phases clean. Tell the user to review and commit. | +| 1 | Could not start — bad args, missing `CURSOR_API_KEY`, or agent startup error. | +| 2 | Critical findings remain after `--max-revisions`. Trees left dirty; surface the findings. | +| 3 | The agent ran but failed mid-execution. Report the logged `agent` and `run` IDs. | + +## Finding the CLI + +`scripts/run.sh` resolves in this order, first hit wins: + +1. `$ESSENTIALS_SYNC_BIN` +2. `essentials-sync` on `$PATH` (the `npm link` case) +3. `$ESSENTIALS_REPO/tools/typescript/essentials-sync/dist/cli.js` +4. The same path relative to this skill, when it still lives inside an essentials checkout + +If none resolve, the script prints the build-and-link steps and exits 1. Set `ESSENTIALS_REPO` to use a clone without linking. diff --git a/skills/ess/essentials-sync/scripts/run.sh b/skills/ess/essentials-sync/scripts/run.sh new file mode 100755 index 0000000..02243f4 --- /dev/null +++ b/skills/ess/essentials-sync/scripts/run.sh @@ -0,0 +1,167 @@ +#!/bin/bash +# Entry point for /essentials-sync — run this script only; do not invoke the CLI directly. +# +# Usage: +# ./run.sh preflight +# ./run.sh dry-run --source --target-repo [...] # adds --dry-run +# ./run.sh sync --source --target-repo [...] +# +# Every argument after the mode is forwarded to essentials-sync verbatim. +# +# Optional: +# ESSENTIALS_SYNC_BIN=/path/to/cli.js explicit binary, wins over everything +# ESSENTIALS_REPO=/path/to/essentials clone to resolve the built CLI from +# +# See ../SKILL.md + +set -euo pipefail + +SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)" +PACKAGE_REL="tools/typescript/essentials-sync" +CLI_REL="$PACKAGE_REL/dist/cli.js" +MIN_NODE_MAJOR=22 + +CLI=() +CLI_SOURCE="" +CLI_PACKAGE_DIR="" + +die() { + echo "ERROR: $*" >&2 + exit 1 +} + +install_hint() { + cat >&2 <<'EOF' + +Could not find the essentials-sync CLI. Build and link it once: + + cd /tools/typescript/essentials-sync + nvm use && npm install && npm run build + npm link # puts `essentials-sync` on $PATH + brew install trufflehog + +Or point this skill at a clone without linking: + + export ESSENTIALS_REPO=/path/to/essentials +EOF + exit 1 +} + +# Turn a resolved path into a runnable command. A .js entry point needs node; +# anything else (an npm-link shim) is executed directly. +set_cli_from_path() { + local target="$1" + if [[ "$target" == *.js ]]; then + CLI=(node "$target") + else + CLI=("$target") + fi +} + +try_repo_root() { + local root="$1" + local cli="$root/$CLI_REL" + [ -d "$root/$PACKAGE_REL" ] || return 1 + CLI_PACKAGE_DIR="$root/$PACKAGE_REL" + [ -f "$cli" ] || return 1 + set_cli_from_path "$cli" + return 0 +} + +resolve_cli() { + if [ -n "${ESSENTIALS_SYNC_BIN:-}" ]; then + [ -f "$ESSENTIALS_SYNC_BIN" ] || die "ESSENTIALS_SYNC_BIN is set but not a file: $ESSENTIALS_SYNC_BIN" + set_cli_from_path "$ESSENTIALS_SYNC_BIN" + CLI_SOURCE="ESSENTIALS_SYNC_BIN" + return 0 + fi + + if command -v essentials-sync >/dev/null 2>&1; then + CLI=(essentials-sync) + CLI_SOURCE="PATH ($(command -v essentials-sync))" + return 0 + fi + + if [ -n "${ESSENTIALS_REPO:-}" ] && try_repo_root "$ESSENTIALS_REPO"; then + CLI_SOURCE="ESSENTIALS_REPO ($ESSENTIALS_REPO)" + return 0 + fi + + # Still living inside the essentials checkout: skills/ess//scripts/ + local in_repo_root + in_repo_root="$(cd "$SCRIPT_DIR/../../../.." 2>/dev/null && pwd || true)" + if [ -n "$in_repo_root" ] && try_repo_root "$in_repo_root"; then + CLI_SOURCE="in-repo ($in_repo_root)" + return 0 + fi + + if [ -n "$CLI_PACKAGE_DIR" ]; then + echo "ERROR: found $CLI_PACKAGE_DIR but it has no dist/cli.js — the package is not built." >&2 + fi + install_hint +} + +preflight() { + local status=0 + + if ! command -v node >/dev/null 2>&1; then + echo "FAIL node is not installed (need >= $MIN_NODE_MAJOR)" + status=1 + else + local major + major="$(node -p 'process.versions.node.split(".")[0]')" + if [ "$major" -lt "$MIN_NODE_MAJOR" ]; then + echo "FAIL node $(node -v) is too old (need >= $MIN_NODE_MAJOR)" + status=1 + else + echo "ok node $(node -v)" + fi + fi + + resolve_cli + echo "ok cli via $CLI_SOURCE" + + # The CLI loads .env from the working directory and from its own package root. + if [ -n "${CURSOR_API_KEY:-}" ]; then + echo "ok CURSOR_API_KEY is set" + elif [ -f "$PWD/.env" ] || { [ -n "$CLI_PACKAGE_DIR" ] && [ -f "$CLI_PACKAGE_DIR/.env" ]; }; then + echo "ok CURSOR_API_KEY not exported, but a .env is present for the CLI to load" + else + echo "FAIL CURSOR_API_KEY is not set and no .env was found" + status=1 + fi + + if command -v trufflehog >/dev/null 2>&1; then + echo "ok trufflehog $(trufflehog --version 2>&1 | head -n1)" + else + echo "WARN trufflehog is not installed — that scanner will be skipped (brew install trufflehog)" + fi + + return "$status" +} + +MODE="${1:-}" +shift || true + +case "$MODE" in + preflight) + preflight + ;; + dry-run) + resolve_cli + echo "[skill] cli via $CLI_SOURCE" >&2 + exec "${CLI[@]}" --dry-run "$@" + ;; + sync) + resolve_cli + echo "[skill] cli via $CLI_SOURCE" >&2 + exec "${CLI[@]}" "$@" + ;; + *) + if [ -n "$MODE" ]; then + echo "ERROR: unknown mode: $MODE" >&2 + fi + echo "Usage: $0 [preflight|dry-run|sync] [essentials-sync args...]" >&2 + exit 1 + ;; +esac