{"id":50661930,"url":"https://github.com/vanityurls/v8s-link","last_synced_at":"2026-06-08T03:04:35.373Z","repository":{"id":361734356,"uuid":"1255494596","full_name":"vanityURLs/v8s-link","owner":"vanityURLs","description":null,"archived":false,"fork":false,"pushed_at":"2026-06-01T02:08:35.000Z","size":744,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-06-01T04:09:07.162Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","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/vanityURLs.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":"AGENTS.md","dco":null,"cla":null}},"created_at":"2026-05-31T22:30:24.000Z","updated_at":"2026-06-01T02:08:38.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/vanityURLs/v8s-link","commit_stats":null,"previous_names":["vanityurls/v8s-link"],"tags_count":null,"template":false,"template_full_name":null,"purl":"pkg:github/vanityURLs/v8s-link","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vanityURLs%2Fv8s-link","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vanityURLs%2Fv8s-link/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vanityURLs%2Fv8s-link/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vanityURLs%2Fv8s-link/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/vanityURLs","download_url":"https://codeload.github.com/vanityURLs/v8s-link/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vanityURLs%2Fv8s-link/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":34046005,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-06-08T02:00:07.615Z","response_time":111,"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":[],"created_at":"2026-06-08T03:04:34.221Z","updated_at":"2026-06-08T03:04:35.363Z","avatar_url":"https://github.com/vanityURLs.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# vanityURLs instance\n\nThis repository contains the source of truth for a vanityURLs short-link redirector instance.\n\nInstance-owned configuration lives in `custom/` and `wrangler.toml`. Product defaults live in `defaults/` and are\nrefreshed by `npm run upgrade`. By default, upgrades pull the latest stable upstream release tag; use\n`npm run upgrade -- --ref main` only when intentionally testing unreleased product code.\n\n## Everyday workflow\n\nInstall dependencies once after cloning or upgrading:\n\n```bash\nnpm install\n```\n\nReview the current links:\n\n```bash\n./scripts/v8s-lnk list\n```\n\nAdd or edit links with `./scripts/v8s-lnk`, then verify link-only changes:\n\n```bash\nnpm run check:links\n```\n\nRun `npm run check` for broader product, template, or policy changes.\n\nCommit and push changes to GitHub. When the repository is connected to Cloudflare Workers \u0026 Pages, Cloudflare deploys\nthe pushed commit automatically.\n\n## Important files\n\n- `custom/v8s-links.txt` is the human-authored source of truth for short links\n- `custom/v8s-site-config.json` stores instance settings such as domain, languages, operator contacts, branding, and\n  link defaults\n- `custom/v8s-policies.json` replaces the default destination policy when an instance needs its own policy\n- `custom/v8s-custom-overrides.json` can document intentional doctor ignores for instance-owned custom public files\n- `wrangler.toml` stores the Worker name, route, assets binding, and Cloudflare variables\n\nGenerated files in `build/`, `src/`, and `functions/` are build outputs. Do not edit them directly.\n\n## Useful commands\n\n```bash\nnpm run setup\nnpm run upgrade\nnpm run help\nnpm run check\nnpm run test\nnpm run validate\nnpm run smoke\nnpm run local-install\nnode scripts/check-upstream-release.mjs\n./scripts/v8s-lnk --help\n./scripts/v8s-lnk list\n```\n\nGrouped commands run the whole group by default. Use focused variants such as `npm run test:worker`,\n`npm run check:links`, `npm run validate:targets`, or `npm run smoke:analytics` when you only need one layer.\n\n## Optional upgrade nudge\n\nvanityURLs does not phone home. To get a pull-based monthly reminder when this instance falls behind upstream releases,\ncopy the workflow template into this repository:\n\n```bash\nmkdir -p .github/workflows\ncp defaults/github/workflows/vanityurls-upgrade-nudge.yml .github/workflows/\n```\n\nThe workflow checks the public GitHub releases API monthly and opens or updates one issue in this repository when a\nnewer vanityURLs release is available. It does not send this instance's links or configuration upstream.\n\nFor an opt-in local check, run:\n\n```bash\nnpm run doctor -- --check-upstream\n```\n\nOffline or unavailable network checks are non-fatal.\n\n## Documentation\n\nUse the vanityURLs documentation site for setup, customization, and operations:\n\n- Quickstart: https://www.vanityurls.link/en/docs/setup/quickstart/\n- v8s-lnk command line interface: https://www.vanityurls.link/en/docs/command-line-interface/lnk/\n- Configuration files: https://www.vanityurls.link/en/docs/reference/configuration-files/\n- Upgrading an instance: https://www.vanityurls.link/en/docs/reference/upgrading/\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvanityurls%2Fv8s-link","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fvanityurls%2Fv8s-link","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvanityurls%2Fv8s-link/lists"}