agentleFS
GoldziherGoldziher/spikard/docs/llms.txt

spikard

llms.txt123 starsChanged 33 days agoMITView on GitHub

Codegen-first polyglot web toolkit with a Rust core and 14 language bindings: Python, TypeScript/Node, Ruby, PHP, Elixir, Go, Java, C#, Kotlin, Dart, Swift, Zig, C FFI, and WebAssembly. Spec-driven codegen (OpenAPI, AsyncAPI, GraphQL, JSON-RPC, gRPC, SQL-to-HTTP), type-safe routing, middleware, validation, and lifecycle hooks across all platforms. Experimental and pre-1.0.

  • Installs packages
  • In this repositoryOne other file it gives its agents.

The file

We split this llms.txt into the rules it gives an agent

1 rule. About 0 are common, 1 is distinctive, and 0 are very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈1

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 0

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    Zig: Add to build.zig.zon

    line 61

≈ “Common” is an estimate: at least 1 in 5 of the 3,727 llms.txt files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
llms.txt
# Spikard

> Codegen-first polyglot web toolkit with a Rust core and 14 language bindings: Python, TypeScript/Node, Ruby, PHP, Elixir, Go, Java, C#, Kotlin, Dart, Swift, Zig, C FFI, and WebAssembly. Spec-driven codegen (OpenAPI, AsyncAPI, GraphQL, JSON-RPC, gRPC, SQL-to-HTTP), type-safe routing, middleware, validation, and lifecycle hooks across all platforms. Experimental and pre-1.0.

## Get Started

- [Installation](https://spikard.dev/getting-started/installation/): Install the binding for your language.
- [Quick Start](https://spikard.dev/getting-started/quickstart/): Build and run your first app in 5 minutes.
- [Init Command](https://spikard.dev/getting-started/init-command/): Generate a project scaffold with `spikard init`.

## Guides

- [Routing Basics](https://spikard.dev/guides/routing/): HTTP method handlers, path parameters, query strings.
- [Requests & Responses](https://spikard.dev/guides/requests/): Typed request/response APIs, body parsing, file uploads.
- [Configuration](https://spikard.dev/guides/configuration/): Server config, middleware setup, deployment options.
- [Middleware](https://spikard.dev/guides/middleware/): Built-in middleware (CORS, compression, rate limit) and custom handlers.
- [Validation Flows](https://spikard.dev/guides/validation/): Schema validation, error responses, constraint parsing.
- [Dependency Injection](https://spikard.dev/guides/dependency-injection/): Service registration and resolver patterns.
- [Testing](https://spikard.dev/guides/testing/): TestClient for in-process integration tests.
- [Deployment](https://spikard.dev/guides/deployment/): Docker, Kubernetes, serverless platforms.
- [Code Generation](https://spikard.dev/guides/code-generation/): OpenAPI, GraphQL, JSON-RPC schema handlers.
- [Streaming & Real-Time](https://spikard.dev/playbooks/streaming/): WebSocket, Server-sent events (SSE), chunked responses.

## Concepts

- [Architecture](https://spikard.dev/concepts/architecture/): Workspace layout, binding strategy, FFI boundaries.
- [Architecture Diagram](https://spikard.dev/concepts/architecture-diagram/): Visual overview of core + 14 bindings.
- [Runtime Model](https://spikard.dev/concepts/runtime/): Async runtime, thread pools, lifecycle hooks.
- [Validation Engine](https://spikard.dev/concepts/validation/): Schema validation pipeline, error attribution.
- [Middleware & Extensions](https://spikard.dev/concepts/middleware/): Tower-http stack, hook lifecycle, composition.
- [Streaming & Async IO](https://spikard.dev/concepts/streaming/): WebSocket, SSE, chunked encoding patterns.
- [Versioning & Stability](https://spikard.dev/concepts/versioning/): Semver policy, C ABI guarantees, deprecation timeline.

## Reference

- [Feature Parity](https://spikard.dev/reference/feature-parity/): Support matrix for WebSocket, SSE, gRPC, GraphQL, auth across all bindings.
- [Types](https://spikard.dev/reference/types/): Core request/response types, ServerConfig, exception hierarchy.
- [Configuration](https://spikard.dev/reference/configuration/): All ServerConfig fields with type, default, and override scope.
- [Errors](https://spikard.dev/reference/errors/): Exception types, error codes, ProblemDetails format.
- [Python API](https://spikard.dev/reference/api-python/): PyO3 binding, decorator syntax, Pydantic integration.
- [TypeScript API](https://spikard.dev/reference/api-typescript/): NAPI-RS binding, Hono-style Context, zod validation.
- [Ruby API](https://spikard.dev/reference/api-ruby/): Magnus binding, Sinatra-style block handlers.
- [PHP API](https://spikard.dev/reference/api-php/): ext-php-rs binding, attribute-based routing.
- [Elixir API](https://spikard.dev/reference/api-elixir/): Rustler binding, Plug.Router macros.
- [Rust API](https://spikard.dev/reference/api-rust/): Core Axum-based API.

## Installation snippets

- **Rust**: `cargo add spikard`
- **Python**: `pip install spikard` (Python ≥ 3.11)
- **TypeScript**: `pnpm add @spikard/node` (Node ≥ 22)
- **Ruby**: `gem install spikard` (Ruby ≥ 3.3)
- **PHP**: `composer require goldziher/spikard` (PHP ≥ 8.3)
- **Elixir**: `{:spikard, "~> 0.17"}` in mix.exs (Elixir ≥ 1.17)
- **Go**: `go get github.com/Goldziher/spikard`
- **Java**: Maven artifact `dev.spikard:spikard:0.17.0-rc.11` (Java ≥ 25)
- **C#**: `dotnet add package Spikard` (.NET 10)
- **Kotlin**: `implementation("dev.spikard:spikard:0.17.0-rc.11")` (Kotlin ≥ 1.8)
- **Dart**: `dart pub add spikard` (Dart ≥ 3.13)
- **Swift**: `.package(url: "...", from: "0.17.0-rc.11")` in Package.swift (Swift ≥ 5.9)
- **Zig**: Add to build.zig.zon
- **C**: spikard-ffi header + shared library from releases
- **WASM**: `pnpm add @spikard/node-wasm`

## Migration

- [v0.15 → v0.16](https://spikard.dev/migration/v0.15-to-v0.16/): Breaking changes, handler signature updates, new exception hierarchy.

## Ecosystem

- [xberg](https://docs.xberg.io): Document intelligence — text, tables, metadata from 91+ file formats. Extraction API and SDKs.
- [xberg Cloud](https://kreuzberg.cloud): Managed SaaS API for document extraction with dashboards and observability.
- [html-to-markdown](https://docs.html-to-markdown.xberg.io): Fast HTML→Markdown conversion engine. 12 language bindings.
- [liter-llm](https://docs.liter-llm.xberg.io): Universal LLM API client. 14 language bindings, 143+ LLM providers.
- [tree-sitter-language-pack](https://docs.tree-sitter-language-pack.xberg.io): 306 tree-sitter grammars on demand plus code-intelligence primitives.
- [alef](https://github.com/xberg-io/alef): The polyglot binding generator that powers Spikard and all xberg ecosystem projects.
- [scythe](https://github.com/Goldziher/scythe): SQL-to-typed-code compiler. Powers Spikard's SQL-to-HTTP codegen.

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.