# ShipSilently

> Cloudflare-native feature flag service. Flags are evaluated either against the
> hosted API or fully locally against a cached configuration blob, with sticky
> percentage rollouts, rule-based targeting, reusable segments, and a kill
> switch per flag.

Key facts an implementer needs up front:

- API base URL: https://api.shipsilently.com
- SDK auth: `X-API-Key: sk_live_…` header. Keys are scoped to one environment.
  There is currently **one** kind of key and it is a **server** key — there is no
  public/browser-safe key type yet, so never ship one to a client bundle.
- Management API (/api/v2) auth: `Authorization: <token>`, raw, no `Bearer` prefix.
- Packages: `@shipsilently/node`, `@shipsilently/edge`, `@shipsilently/react`, `github.com/shipsilently/shipsilently-go`.
- Evaluation reasons: `rule_match`, `rollout`, `flag_disabled`, `default`, `flag_not_found`.
- Targeting operators are short identifiers: `eq`, `neq`, `contains`,
  `not_contains`, `starts_with`, `ends_with`, `gt`, `gte`, `lt`, `lte`, `in`,
  `not_in`, `regex`, `segment_match`. They are **not** spelled out
  (`equals`/`greater_than` are invalid).
- A percentage rollout is a property of a **rule**, not of a flag. A user who
  matches a rule but falls outside its percentage **falls through to the next
  rule** rather than ending evaluation.

## Docs

- [Quick Start](https://www.shipsilently.com/docs/): install, initialize, evaluate.
- [Core Concepts](https://www.shipsilently.com/docs/concepts/): flags, rules, contexts, environments, segments, evaluation reasons.
- [JavaScript / TypeScript SDK](https://www.shipsilently.com/docs/javascript/): async network-backed client; streaming, analytics, browser guidance.
- [Edge SDK](https://www.shipsilently.com/docs/edge/): synchronous local evaluation; hosted, bring-your-own-KV, or static blob.
- [React SDK](https://www.shipsilently.com/docs/react/): provider and typed hooks.
- [Go SDK](https://www.shipsilently.com/docs/go/): generic evaluation, streaming, last-known-good cache.
- [OpenFeature](https://www.shipsilently.com/docs/openfeature/): vendor-neutral provider.
- [REST API](https://www.shipsilently.com/docs/api/): evaluation endpoints and error semantics.
- [Resilience](https://www.shipsilently.com/docs/resilience/): failure matrix, reconnection, cold-start caveats.

## Guides

- [Percentage Rollouts](https://www.shipsilently.com/docs/guides/rollouts/): bucketing, stickiness, rule fall-through.
- [User Targeting](https://www.shipsilently.com/docs/guides/targeting/): operators and matching semantics.
- [Segments](https://www.shipsilently.com/docs/guides/segments/): reusable audiences.
- [Kill Switches](https://www.shipsilently.com/docs/guides/kill-switches/): disabling a feature safely.

## Optional

- [Full docs as one file](https://www.shipsilently.com/llms-full.txt): every page above expanded, with all code examples verbatim.
- [OpenAPI 3.0 spec](https://www.shipsilently.com/openapi.json): the complete management API.
- [Interactive API reference](https://www.shipsilently.com/api/)