{"id":27952034,"url":"https://github.com/swup/cli","last_synced_at":"2025-10-07T04:45:52.135Z","repository":{"id":34881878,"uuid":"186304401","full_name":"swup/cli","owner":"swup","description":"Create swup plugins and themes in seconds, or validate your website 🚤","archived":false,"fork":false,"pushed_at":"2025-08-06T18:07:57.000Z","size":1639,"stargazers_count":5,"open_issues_count":0,"forks_count":1,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-08-06T20:18:36.741Z","etag":null,"topics":["cli","page-transitions","plugins","swup","themes"],"latest_commit_sha":null,"homepage":"https://swup.js.org/cli","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/swup.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null},"funding":{"github":["gmrchk","daun","hirasso"],"open_collective":"swup"}},"created_at":"2019-05-12T21:09:47.000Z","updated_at":"2025-08-06T18:06:52.000Z","dependencies_parsed_at":"2025-09-02T00:31:52.142Z","dependency_job_id":null,"html_url":"https://github.com/swup/cli","commit_stats":{"total_commits":99,"total_committers":5,"mean_commits":19.8,"dds":0.5353535353535354,"last_synced_commit":"f2b2f8a4609437b3d7acf7febbb2d33ac0da6d7c"},"previous_names":[],"tags_count":11,"template":false,"template_full_name":null,"purl":"pkg:github/swup/cli","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/swup%2Fcli","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/swup%2Fcli/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/swup%2Fcli/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/swup%2Fcli/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/swup","download_url":"https://codeload.github.com/swup/cli/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/swup%2Fcli/sbom","scorecard":{"id":862386,"data":{"date":"2025-08-11","repo":{"name":"github.com/swup/cli","commit":"3565fd83ee67f7c47efedc5b922399cec001332c"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":4.2,"checks":[{"name":"Dangerous-Workflow","score":10,"reason":"no dangerous workflow patterns detected","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Maintained","score":1,"reason":"2 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 1","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"Code-Review","score":10,"reason":"all changesets reviewed","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Token-Permissions","score":0,"reason":"detected GitHub workflow tokens with excessive permissions","details":["Warn: no topLevel permission defined: .github/workflows/npm-publish.yml:1","Warn: no topLevel permission defined: .github/workflows/redeploy-docs.yml:1","Warn: no topLevel permission defined: .github/workflows/version-update.yml:1","Info: no jobLevel write permissions found"],"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"Pinned-Dependencies","score":4,"reason":"dependency not pinned by hash detected -- score normalized to 4","details":["Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/npm-publish.yml:13: update your workflow using https://app.stepsecurity.io/secureworkflow/swup/cli/npm-publish.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/npm-publish.yml:14: update your workflow using https://app.stepsecurity.io/secureworkflow/swup/cli/npm-publish.yml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/redeploy-docs.yml:8: update your workflow using https://app.stepsecurity.io/secureworkflow/swup/cli/redeploy-docs.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/version-update.yml:22: update your workflow using https://app.stepsecurity.io/secureworkflow/swup/cli/version-update.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/version-update.yml:23: update your workflow using https://app.stepsecurity.io/secureworkflow/swup/cli/version-update.yml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/version-update.yml:30: update your workflow using https://app.stepsecurity.io/secureworkflow/swup/cli/version-update.yml/main?enable=pin","Info:   0 out of   4 GitHub-owned GitHubAction dependencies pinned","Info:   0 out of   2 third-party GitHubAction dependencies pinned","Info:   2 out of   2 npmCommand dependencies pinned"],"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: MIT License: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":-1,"reason":"internal error: error during branchesHandler.setup: internal error: githubv4.Query: Resource not accessible by integration","details":null,"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 30 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}},{"name":"Vulnerabilities","score":0,"reason":"20 existing vulnerabilities detected","details":["Warn: Project is vulnerable to: GHSA-968p-4wvh-cqc8","Warn: Project is vulnerable to: GHSA-h5c3-5r3r-rr8q","Warn: Project is vulnerable to: GHSA-rmvr-2pp2-xj38","Warn: Project is vulnerable to: GHSA-xx4v-prfh-6cgc","Warn: Project is vulnerable to: GHSA-v6h2-p8h4-qcjw","Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg","Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275","Warn: Project is vulnerable to: GHSA-fjxv-7rqg-78g4","Warn: Project is vulnerable to: GHSA-2p57-rm9w-gvfp","Warn: Project is vulnerable to: GHSA-p6mc-m468-83gw","Warn: Project is vulnerable to: GHSA-35jh-r3h4-6jhm","Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv","Warn: Project is vulnerable to: GHSA-mwcw-c2x4-8c55","Warn: Project is vulnerable to: GHSA-rp65-9cf3-cjxr","Warn: Project is vulnerable to: GHSA-p8p7-x288-28g6","Warn: Project is vulnerable to: GHSA-gcx4-mw62-g8wm","Warn: Project is vulnerable to: GHSA-76p7-773f-r4q5","Warn: Project is vulnerable to: GHSA-f5x3-32g6-xq36","Warn: Project is vulnerable to: GHSA-52f5-9888-hmc6","Warn: Project is vulnerable to: GHSA-72xf-g2v4-qvf3"],"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}}]},"last_synced_at":"2025-08-24T01:40:25.876Z","repository_id":34881878,"created_at":"2025-08-24T01:40:25.876Z","updated_at":"2025-08-24T01:40:25.876Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":273213856,"owners_count":25065058,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-09-01T02:00:09.058Z","response_time":120,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cli","page-transitions","plugins","swup","themes"],"created_at":"2025-05-07T16:27:21.715Z","updated_at":"2025-10-07T04:45:47.091Z","avatar_url":"https://github.com/swup.png","language":"TypeScript","funding_links":["https://github.com/sponsors/gmrchk","https://github.com/sponsors/daun","https://github.com/sponsors/hirasso","https://opencollective.com/swup"],"categories":[],"sub_categories":[],"readme":"# Swup CLI\n\n\u003cdiv class=\"shields\"\u003e\n\n[![Version](https://img.shields.io/npm/v/@swup/cli.svg)](https://npmjs.org/package/@swup/cli)\n[![License](https://img.shields.io/npm/l/@swup/cli.svg)](https://github.com/gmrchk/cli/blob/main/package.json)\n[![oclif](https://img.shields.io/badge/cli-oclif-brightgreen.svg)](https://oclif.io)\n\n\u003c/div\u003e\n\nA command-line interface (CLI) to help develop [swup](https://swup.js.org/) sites and plugins.\n\n- Validate your website in CI/CD\n- Create plugins and themes from a best-practice template\n- Bundle plugins and themes using microbundle\n\n![terminal screenshot](https://github.com/swup/cli/assets/869813/0d59b849-0801-4043-a325-801ed2d2982d)\n\n\n## Contents\n\n- [Installation](#installation)\n- [Usage](#usage)\n- [Commands](#commands)\n\n## Installation\n\nInstall the CLI globally from npm.\n\n```sh\nnpm install -g @swup/cli\n```\n\n## Usage\n\nThe CLI will install a binary called `swup` you can run, followed by any of the provided [commands](#commands).\n\n```sh\n$ swup [command]\n\u003e Running command...\n\n$ swup --help [command]\n\u003e Show help for command [command]\n\n$ swup --version\n\u003e @swup/cli/5.0.3 darwin-arm64 node-v18.16.0\n```\n\n## Commands\n\n\u003c!-- commands --\u003e\n* [`swup create NAME`](#swup-create-name)\n* [`swup help [COMMANDS]`](#swup-help-commands)\n* [`swup package:build`](#swup-packagebuild)\n* [`swup package:check`](#swup-packagecheck)\n* [`swup package:dev`](#swup-packagedev)\n* [`swup package:format`](#swup-packageformat)\n* [`swup package:lint`](#swup-packagelint)\n* [`swup validate`](#swup-validate)\n\n## `swup create NAME`\n\nCreate a swup plugin or theme\n\n```\nUSAGE\n  $ swup create NAME [-t plugin|theme]\n\nARGUMENTS\n  NAME  Name of the plugin to create\n\nFLAGS\n  -t, --type=\u003coption\u003e  [default: plugin] Type\n                       \u003coptions: plugin|theme\u003e\n\nDESCRIPTION\n  Create a swup plugin or theme\n\n  Generate a new swup plugin or theme from an official, best-practice template\n\nEXAMPLES\n  $ swup create SwupExamplePlugin\n\n  $ swup create SwupExampleTheme\n\nFLAG DESCRIPTIONS\n  -t, --type=plugin|theme  Type\n\n    Choose the type of project to create: plugin or theme. Not required if name ends with \"Plugin\" or \"Theme\".\n```\n\n_See code: [src/commands/create.ts](https://github.com/swup/cli/blob/5.0.3/src/commands/create.ts)_\n\n## `swup help [COMMANDS]`\n\nDisplay help for swup.\n\n```\nUSAGE\n  $ swup help [COMMANDS] [-n]\n\nARGUMENTS\n  COMMANDS  Command to show help for.\n\nFLAGS\n  -n, --nested-commands  Include all nested commands in the output.\n\nDESCRIPTION\n  Display help for swup.\n```\n\n_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v5.2.20/src/commands/help.ts)_\n\n## `swup package:build`\n\nBuild package\n\n```\nUSAGE\n  $ swup package:build [--check]\n\nFLAGS\n  --[no-]check  Check package info\n\nDESCRIPTION\n  Build package\n\n  Build package code for distribution using microbundle\n\nEXAMPLES\n  $ swup package:build\n\nFLAG DESCRIPTIONS\n  --[no-]check  Check package info\n\n    Check for required package.json fields before bundling. Disable using --no-check.\n```\n\n_See code: [src/commands/package/build.ts](https://github.com/swup/cli/blob/5.0.3/src/commands/package/build.ts)_\n\n## `swup package:check`\n\nCheck package info\n\n```\nUSAGE\n  $ swup package:check\n\nDESCRIPTION\n  Check package info\n\n  Ensure a bundle package.json is valid\n\nEXAMPLES\n  $ swup package:check\n```\n\n_See code: [src/commands/package/check.ts](https://github.com/swup/cli/blob/5.0.3/src/commands/package/check.ts)_\n\n## `swup package:dev`\n\nDevelop package\n\n```\nUSAGE\n  $ swup package:dev [--check]\n\nFLAGS\n  --[no-]check  Check package info\n\nDESCRIPTION\n  Develop package\n\n  Build package code for development using microbundle and watch for changes\n\nEXAMPLES\n  $ swup package:dev\n\nFLAG DESCRIPTIONS\n  --[no-]check  Check package info\n\n    Check for required package.json fields before bundling. Disable using --no-check.\n```\n\n_See code: [src/commands/package/dev.ts](https://github.com/swup/cli/blob/5.0.3/src/commands/package/dev.ts)_\n\n## `swup package:format`\n\nFormat package\n\n```\nUSAGE\n  $ swup package:format\n\nDESCRIPTION\n  Format package\n\n  Fix code formatting issues using prettier\n\nEXAMPLES\n  $ swup package:format\n```\n\n_See code: [src/commands/package/format.ts](https://github.com/swup/cli/blob/5.0.3/src/commands/package/format.ts)_\n\n## `swup package:lint`\n\nLint package\n\n```\nUSAGE\n  $ swup package:lint\n\nDESCRIPTION\n  Lint package\n\n  Check code for formatting issues using prettier\n\nEXAMPLES\n  $ swup package:lint\n```\n\n_See code: [src/commands/package/lint.ts](https://github.com/swup/cli/blob/5.0.3/src/commands/package/lint.ts)_\n\n## `swup validate`\n\nValidate a swup-powered site\n\n```\nUSAGE\n  $ swup validate [-u \u003cvalue\u003e | -s \u003cvalue\u003e] [-c] [-l \u003cvalue\u003e] [-t\n    all|containers|transition-duration|transition-styles] [-p] [--containers \u003cvalue\u003e] [--animation \u003cvalue\u003e] [--styles\n    \u003cvalue\u003e]\n\nFLAGS\n  -c, --crawl            Crawl site\n  -l, --limit=\u003cvalue\u003e    Limit\n  -p, --parallel         Parallel\n  -s, --sitemap=\u003cvalue\u003e  Sitemap\n  -t, --tests=\u003coption\u003e   [default: all] Tests\n                         \u003coptions: all|containers|transition-duration|transition-styles\u003e\n  -u, --url=\u003cvalue\u003e      URL\n  --animation=\u003cvalue\u003e    [default: [class*=\"transition-\"]] Animation selector\n  --containers=\u003cvalue\u003e   [default: #swup] Containers\n  --styles=\u003cvalue\u003e       [default: opacity,transform] Expected styles\n\nDESCRIPTION\n  Validate a swup-powered site\n\n  Crawl your site and validate that all pages are accessible and render correctly\n\nEXAMPLES\n  $ swup validate\n\n  $ swup validate --url https://mysite.com/about\n\n  $ swup validate --crawl --url https://mysite.com\n\n  $ swup validate --tests containers,transition-duration\n\n  $ swup validate --asynchronous\n\nFLAG DESCRIPTIONS\n  -c, --crawl  Crawl site\n\n    Crawl the site for all public URLs and validate all found pages. Requires the --url flag as a base URL.\n\n  -l, --limit=\u003cvalue\u003e  Limit\n\n    Limit the number of pages to validate when crawling or reading from a sitemap.\n\n  -p, --parallel  Parallel\n\n    Run all tests asynchronously. A lot faster, but might cause issues.\n\n  -s, --sitemap=\u003cvalue\u003e  Sitemap\n\n    If no URL is passed, the local sitemap file will be scanned for public URLs. Accepts a local filepath or URL.\n\n  -t, --tests=all|containers|transition-duration|transition-styles  Tests\n\n    Specify which tests to run when validating. Defaults to all.\n\n  -u, --url=\u003cvalue\u003e  URL\n\n    Base URL to validate. Will validate this single URL only, unless --crawl is specified.\n\n  --animation=\u003cvalue\u003e  Animation selector\n\n    Selector of elements that should be animated.\n\n  --containers=\u003cvalue\u003e  Containers\n\n    Selectors of containers to validate, separated by comma.\n\n  --styles=\u003cvalue\u003e  Expected styles\n\n    CSS properties expected to change during animations, separated by comma.\n```\n\n_See code: [src/commands/validate.ts](https://github.com/swup/cli/blob/5.0.3/src/commands/validate.ts)_\n\u003c!-- commandsstop --\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fswup%2Fcli","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fswup%2Fcli","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fswup%2Fcli/lists"}