@jimhoyd/urlcode 0.3.0

package/CONTRIBUTING.md

@@ -0,0 +1,80 @@
+# Contributing
+
+URLCode is licensed under the Apache License 2.0. By submitting a contribution,
+you agree that it may be distributed under that license and represent that you
+have the right to submit it.
+
+Use Node.js 22.18+ (the source is TypeScript, run directly through Node's type
+stripping; CI targets 22, 24 and 26). Installed packages still run on 22.13+:
+
+```sh
+make dev         # installs dependencies and starts the watched function/redirect demo
+# In another terminal:
+make verify
+make test-package
+```
+
+Without Make, use `npm ci`, `npm run dev`, `npm run verify` and
+`npm run test:package`. See [local development](docs/LOCAL-DEVELOPMENT.md) for
+project/port overrides and the independent app workflow.
+
+Verification runs ESLint, the TypeScript type check (`npm run typecheck`,
+strict, over `src`, `scripts`, `test` and `benchmarks`), syntax/JSON checks and
+unit/real HTTP tests; keep all of it green. There is no build in the local
+loop: `npm run dev` runs `src/cli.ts` directly. `npm run build` emits `dist/`,
+the JavaScript the package and container run, plus its declarations; `dist` is
+never committed. Package verification builds, installs an actual archive in a
+temporary directory and checks the starter and a TypeScript consumer of the
+shipped declarations. It needs npm registry access. Default runtime tests use only local
+HTTP/fake services; no hosting account, DB or ngrok. Benchmarks are separate:
+`npm run benchmark -- 10000`.
+
+Keep changes consistent with the [implemented contract](docs/SPECIFICATION.md)
+and [roadmap](ROADMAP.md). Add behavior/conformance tests for routing changes and
+update docs when support changes. Do not claim a provider or OS is supported
+without a passing test run. Preserve portable behavior and useful self-hosting.
+
+Use synthetic data. Never commit secrets, customer URL collections or local
+environment files. Treat all application function code as untrusted. Never import it into Node or
+add an unsafe fallback. Capability grants must come from operator policy outside
+the project. Extend adversarial tests with every new guest/host bridge. See the
+[security model](docs/FUNCTION-SECURITY.md).
+
+## Maintaining the starter
+
+`starters/default` is the only initializer source. Keep its route YAML, functions
+and request fixtures aligned with the public `urlcode-template` repository.
+The public template adds its pinned runtime dependency, npm commands and CI;
+CLI initialization uses the user's already installed runtime. Test both paths.
+The richer asset demo lives in `examples/assets`, not a selectable starter.
+Old starter-dynamic/starter-redirects branches are historical and no longer
+maintained; do not use them in onboarding or publish further subtree updates.
+
+## Keep authoring documentation executable
+
+When changing YAML fields, update schema and semantics, run `npm run docs:reference`,
+and add a runnable example/response fixture in `examples/cookbook` where appropriate.
+`npm run verify` rejects a stale generated field reference. CI runs cookbook tests
+and its expected-count audit on supported Node/OS combinations; package checks
+verify the cookbook and AI authoring resources ship. Keep unsupported features
+explicit in `docs/AI-AUTHORING.md`; never present future roadmap fields as valid YAML.
+
+## Pull requests and review
+
+Work on a branch and open a focused pull request. Explain the problem, resulting
+behavior, validation and compatibility/security implications. Never include real
+credentials or customer data. Use the PR template and keep unrelated changes out.
+
+`main` requires a pull request, an up-to-date branch, the required Node/OS verification
+jobs, container verification, CodeQL results and resolved conversations. High/critical
+security findings and error-level CodeQL alerts block merging. Force pushes and branch
+deletion are blocked; squash merging keeps a linear history. Administrators have
+no configured ruleset bypass. Automation cannot approve pull requests.
+
+The project currently has one maintainer, @jimhoyd. CODEOWNERS identifies the
+responsible reviewer, but no second-person approval is required while there is
+only one maintainer; this is not an independent review guarantee. Require an
+independent approval when another trusted maintainer joins. Security-sensitive
+changes warrant independent review before production use regardless of CI.
+
+See [governance](GOVERNANCE.md) and the [code of conduct](CODE_OF_CONDUCT.md).

package/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 2026 Jimmy Ho
+
+   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.

package/NOTICE

@@ -0,0 +1,20 @@
+URLCode
+Copyright (c) the URLCode contributors
+
+This product is licensed under the Apache License, Version 2.0 (see LICENSE).
+
+This product bundles User-Agent lists derived from third-party data. Each
+upstream licence is reproduced verbatim under data/agents/LICENSES/, and the
+pinned upstream revision is recorded in every data/agents/<list>.json file.
+scripts/sync-agent-lists.js refreshes them.
+
+  ai.robots.txt (data/agents/ai-crawlers.json)
+    https://github.com/ai-robots-txt/ai.robots.txt
+    Copyright (c) 2024 ai.robots.txt
+    Licensed under the MIT License; see data/agents/LICENSES/ai-robots-txt.txt
+
+  crawler-user-agents (data/agents/crawlers.json, seo.json, monitoring.json)
+    https://github.com/monperrus/crawler-user-agents
+    Copyright (c) 2017 Martin Monperrus
+    Licensed under the MIT License; see data/agents/LICENSES/crawler-user-agents.txt
+    Only revisions dated after 2016-11-07 are used, when the project moved to MIT.

package/README.md

@@ -0,0 +1,342 @@
+# URLCode
+
+**A portable runtime for programmable URL behavior.** Define an application's
+public URL surface in YAML, add isolated JavaScript only where declarative
+handlers are not enough, and run the same project locally or on your own
+infrastructure. Your routes, source and data remain yours.
+
+[![Verify](https://github.com/jimhoyd-com/urlcode/actions/workflows/ci.yml/badge.svg)](https://github.com/jimhoyd-com/urlcode/actions/workflows/ci.yml)
+
+[Documentation](docs/README.md) · [Starter](https://github.com/jimhoyd-com/urlcode-template) · [Contributing](CONTRIBUTING.md) · [Security](SECURITY.md)
+
+URLCode is not a URL shortener. Short links are one supported route type beside
+redirects, validated HTTP responses, isolated request functions, middleware,
+pages, static assets and downloads. It is also not a general Node web framework:
+the project format intentionally describes bounded behavior that a runtime can
+validate, inspect and eventually carry across hosting providers.
+
+See [project direction](docs/PROJECT-DIRECTION.md) for the product boundary,
+the relationship to application projects and the license.
+
+## Status
+
+`0.2.0` is the current local/self-hosted release of the implemented
+contract, following `0.1.0`, the first stable one. It includes redirects, parameters, JavaScript
+functions, middleware, live short-link storage, pages, static assets, downloads, starters, tests and process/container packaging. See the
+[implemented contract](docs/SPECIFICATION.md), [operations guide](docs/OPERATIONS.md)
+and [roadmap](ROADMAP.md) for limits and unfinished work.
+
+Live-link storage uses separate bounded reader/writer pools. It requires a Node
+build containing a patched SQLite version — 3.51.3 or newer, 3.50.7, or 3.44.6 —
+which some current releases on a supported Node line do not carry. Run
+`urlcode doctor` and check `liveLinks` before relying on it; everything else
+runs on any supported Node.
+See [pool controls and scaling limits](docs/DYNAMIC-LINKS.md#separate-reader-and-writer-pools).
+
+URLCode is free and open-source software licensed under the
+[Apache License 2.0](LICENSE). Commercial use, modification, redistribution and
+self-hosting are permitted under its terms.
+
+## Documentation
+
+Start with the [YAML guide and recipe book](docs/YAML-GUIDE.md),
+[complete field reference](docs/YAML-REFERENCE.md), and
+[runnable 25-route cookbook](examples/cookbook/README.md). For AI-assisted
+authoring, use [the AI guide](docs/AI-AUTHORING.md) and [llms.txt](llms.txt).
+Follow [organization and readability practices](docs/BEST-PRACTICES.md) as your
+project grows. Operators should read [capacity/concurrency](docs/CAPACITY.md) and the
+[DDoS and recovery playbook](docs/RESILIENCE.md). Embedding the runtime from
+TypeScript is covered in [TypeScript](docs/TYPESCRIPT.md). [All documentation](docs/README.md).
+
+## Start your own project
+
+Use [urlcode-template](https://github.com/jimhoyd-com/urlcode-template) for a small
+app with just a function route and a regular redirect. Clone it or use GitHub’s
+**Use this template** button, then run `npm ci` and `npm run dev`. The runtime is
+a pinned dependency; no separate checkout or global installation is needed.
+
+```sh
+git clone https://github.com/jimhoyd-com/urlcode-template.git my-links
+cd my-links
+npm ci
+npm run dev
+```
+
+Live stored-link routes require **`dynamicLinks: true`** in the entry `urlcode.yaml`;
+the starter explicitly sets false. Ordinary functions and parameterized redirects
+do not need it. [Live-link setup](docs/DYNAMIC-LINKS.md).
+
+## Built with URLCode
+
+[urlcode-shortener](https://github.com/jimhoyd-com/urlcode-shortener) is a
+standalone, account-free demo built on URLCode's public runtime and storage APIs.
+It combines short links that expire after one hour or less, QR downloads, and a
+shadcn/ui + Tailwind frontend. URLCode handles the page/assets and stored-link
+redirects; the application adds anonymous creation and its own limits.
+
+Read its [build retrospective](https://github.com/jimhoyd-com/urlcode-shortener/blob/main/docs/BUILD-RETROSPECTIVE.md)
+for what the runtime supplied, what the application still needed, and proposed
+improvements. The demo's license, hosting and production validation remain open;
+it does not change URLCode's Apache-2.0 license or guest isolation model.
+
+[urlcode-docs](https://github.com/jimhoyd-com/urlcode-docs) demonstrates URLCode
+hosting a static documentation site with shadcn/ui and Tailwind. It syncs this
+repository’s Markdown and examples at a pinned revision, applies templates through
+sandboxed middleware during the build, and serves the output through native
+page/static/download routes. This repository remains the documentation source of
+truth. See the [docs-site retrospective](https://github.com/jimhoyd-com/urlcode-docs/blob/main/docs/BUILD-RETROSPECTIVE.md)
+for reuse, integration work and upstream improvements. Hosting and a public domain
+are not yet selected; the original site-code license is pending.
+
+## Start from YAML
+
+Already wrote `urlcode.yaml`? Run `urlcode scaffold --project ./my-links --dry-run`,
+then remove `--dry-run` to create missing modules, pages and directories. Existing
+files are preserved; code placeholders return 501 until implemented.
+[Scaffolding guide](docs/SCAFFOLDING.md).
+
+## Try it
+
+Requires Node.js 22.13+ and npm; CI targets Node 22, 24 and 26 on macOS, Linux and
+Windows.
+
+```sh
+npm install --global urlcode        # or: brew tap jimhoyd-com/urlcode && brew install urlcode
+urlcode init my-urls && cd my-urls
+urlcode dev
+```
+
+See [installation](docs/INSTALL.md) for the install script, the container image
+and verifying a release's signed provenance. To work from a clone instead:
+
+```sh
+git clone https://github.com/jimhoyd-com/urlcode.git
+cd urlcode
+make dev
+```
+
+`make dev` installs dependencies if needed and starts the included function/redirect demo.
+No global install, account, database, Docker or configuration step is required.
+A clone runs the TypeScript source directly (`node src/cli.ts`, which needs
+Node 22.18+); the installed package runs the built `dist/cli.js`.
+Without Make (including Windows), use:
+
+```sh
+npm ci
+npm run dev
+```
+
+Open `http://127.0.0.1:3000/hello/Ada` to run your custom function,
+`/go` for a regular redirect.
+Edit `starters/default/routes/` or `functions/hello.mjs` under
+that starter; valid changes reload automatically. Press Ctrl+C to stop.
+In another terminal, run `make test-project` or `npm run test:project`.
+
+To create your own independent project:
+
+```sh
+make init DEST=../my-links
+make dev PROJECT=../my-links PORT=3001
+# Without Make:
+npm run init -- ../my-links
+npm run dev -- --project ../my-links --port 3001
+```
+
+Choose either command pair; initialization refuses to overwrite existing work.
+[Starters](docs/STARTERS.md) are ordinary application files, independent of the
+runtime checkout. Own them in your own Git repository. Global `npm link` remains
+optional if you want the `urlcode` command everywhere. See
+[local development](docs/LOCAL-DEVELOPMENT.md) for commands and troubleshooting.
+
+## A URL that runs your function
+
+A request to `/hello/Ada` runs your JavaScript and returns
+`{"message":"Hello, Ada!"}`. Put this in `urlcode.yaml`:
+
+```yaml
+version: "1"
+routes:
+  /hello/{name}:
+    parameters:
+      - name: name
+        in: path
+        required: true
+        schema: {type: string, minLength: 1, maxLength: 80}
+    function:
+      source: functions/hello.mjs
+      args:
+        name: {from: path, name: name}
+    env:
+      GREETING: {value: Hello}
+```
+
+And in `functions/hello.mjs`:
+
+```js
+export default function hello(request, { args, env }) {
+  return Response.json({ message: `${env.GREETING}, ${args.name}!` });
+}
+```
+
+Your function chooses the response: JSON, text, HTML, or a redirect via
+`Response.redirect("https://example.com", 302)`. The starter includes
+this runnable example. Functions run in an isolated sandbox; see its supported
+[API and security boundaries](docs/FUNCTION-SECURITY.md).
+
+## Reusable middleware
+
+Add an ordered `middleware` list alongside any route handler:
+
+```yaml
+    middleware:
+      - source: middleware/headers.mjs
+```
+
+```js
+export default async function headers(request, context, next) {
+  const response = await next();
+  response.headers.set('x-example-middleware', 'active');
+  return response;
+}
+```
+
+Middleware can return a response early, share request-local `context.state`, or
+wrap the handler with `await next()`. It runs in the same isolated sandbox and
+under one deadline for the whole chain. The starter's function route includes
+this example. See [middleware semantics and limits](docs/MIDDLEWARE.md).
+
+## A URL that redirects
+
+```yaml
+version: "1"
+routes:
+  /go:
+    redirect:
+      url: https://example.com
+      status: 302
+```
+
+Ordinary redirects use an indexed lookup: no database, Lambda or per-route
+user function. Configuration is compiled at startup, not parsed per request.
+Literal paths win over parameterized routes; conflicting definitions fail validation.
+
+Custom functions are ES modules using a documented text/JSON `Request`/`Response`
+subset and validated context. See the
+[starter](starters/default/urlcode.yaml) and [function](starters/default/functions/hello.mjs).
+Functions are treated as untrusted and run inside a QuickJS/WebAssembly sandbox,
+with a fresh heap per invocation. No Node APIs, filesystem, shell, network or
+ambient environment is exposed. Independent worker deadlines bound execution.
+External env/secret bindings require route-scoped operator grants pinned to the
+project revision. See the [security model](docs/FUNCTION-SECURITY.md).
+
+## Pages, files and downloads
+
+Add these routes alongside your functions and redirects:
+
+```yaml
+  /about:
+    page:
+      file: public/about.html
+  /assets/*:
+    static:
+      directory: public/assets
+  /download:
+    download:
+      file: public/guide.txt
+      filename: urlcode-guide.txt
+```
+
+Create the referenced files first. MIME types are detected from file extensions;
+unknown types use `application/octet-stream`. Downloads set attachment headers.
+Optional `contentType` overrides detection. HEAD, ETags, conditional requests and
+single byte ranges are supported. Files are served natively without executing a
+function. See [asset configuration and safety limits](docs/ASSETS.md).
+
+## Organize routes across files
+
+Keep everything in `urlcode.yaml`, or use its `includes` list to load files from
+folders you choose. The [public template](https://github.com/jimhoyd-com/urlcode-template)
+demonstrates a function file and a redirect file in a nested folder. All commands
+see one combined project. See [organization examples](docs/ORGANIZATION.md).
+
+## Route matching and adding links
+
+Routes support exact paths and non-greedy single-segment parameters such as
+`/r/{code}`. Only static-file mounts support a trailing `/*`; regex routing is
+not supported. `dev` swaps validated configuration snapshots when YAML changes;
+`serve` requires restart/redeployment for YAML changes. Stored short links can
+now be created/updated/deleted live without reloads through the optional
+[dynamic-link handler and management API](docs/DYNAMIC-LINKS.md). See [matching, precedence and dynamic-link behavior](docs/ROUTING.md).
+
+## Create short links without restarting
+
+```yaml
+  /r/{code}:
+    parameters:
+      - name: code
+        in: path
+        required: true
+        schema: {type: string, minLength: 1, maxLength: 128}
+    link:
+      collection: links
+      code: {from: path, name: code}
+```
+
+Keep this route in YAML; store individual codes outside Git. Bind an optional
+local SQLite store with `--link-store links=/absolute/links.sqlite`, then use
+`urlcode links create` or the separate authenticated management API. Successful
+record changes are visible without rewriting YAML or rebuilding the route table.
+Ordinary YAML routes still need no database. See [setup, API and limitations](docs/DYNAMIC-LINKS.md).
+
+## HTTP in YAML
+
+Configure methods and validated path/query/header inputs, request body size and
+media types, response headers, cookies, and declared text/JSON responses.
+See the [HTTP configuration reference](docs/HTTP.md) for supported fields and
+examples. Runtime framing and asset validators stay protected.
+
+## Check your links before release
+
+`urlcode routes` lists the configured routes. `urlcode audit --expect-routes 2`
+checks the count, generates native response checks and reports missing route/method
+coverage in your request fixtures. `urlcode benchmark --requests 1000 --concurrency 2`
+measures your local project without following external redirects. Each command
+accepts `--project`. See [readiness and release checks](docs/READINESS.md).
+
+## Commands available
+
+| Command | Purpose |
+|---|---|
+| `init <directory>` | Create an independent starter; refuse existing destinations |
+| `add <url> --alias <code>` | Validate and atomically add a redirect; generate a code if omitted |
+| `validate --local` | Validate config, references, bindings and function initialization; read `.env.local` |
+| `dev` | Local server, watched reload and `.env.local` |
+| `serve` | Fixed production process snapshot; environment injection, no dotenv loading |
+| `test` | Local HTTP assertions from `tests/requests.json`; never follow redirects |
+| `permissions` | Inspect requested bindings and project digest without executing code; grants nothing |
+| `doctor` | Report runtime/platform details and implemented provider scope |
+
+Use `--project <directory>` to select an app. Servers accept `--host`, `--port`
+and `--origin` (public URL origin for functions). Bind defaults to `127.0.0.1`.
+
+## Production direction
+
+The free runtime is meant to be useful and production-capable for people who
+operate it themselves. Current hardening includes strict YAML/schema checks,
+request/response limits, worker deadlines, bounded function concurrency, safe
+configuration replacement, graceful shutdown, health/readiness and structured
+logs without request content. It still needs broader deployment/soak validation
+and the remaining release features. Read [operations](docs/OPERATIONS.md) before
+exposing a server. [Benchmark instructions and measurements](docs/PERFORMANCE.md)
+are available; measurements are not capacity guarantees.
+
+Git owns definitions and code. Secrets stay in ignored `.env.local` for development
+or injected environment values for serving, accessible to functions only through
+an explicit operator policy. Vercel, AWS Lambda and Cloudflare Workers each have a
+target guide in [docs](docs/README.md); none has been deployed to its platform
+yet. Provider secret-store integration, CSV tools, templates/signals,
+Homebrew and richer monitoring are future work. Unsupported config fails rather
+than silently losing behavior. There is no required admin UI or database.
+
+See [contributing](CONTRIBUTING.md), [security](SECURITY.md), and the
+[roadmap](ROADMAP.md).