# Shoal

> Feature flags & remote config for TypeScript teams. Shoal docs: guides, API reference and changelog for feature flags and remote config.

Full text of every page: https://tidemark-demo.pages.dev/llms-full.txt

## Getting started

- [Introduction](https://tidemark-demo.pages.dev/en/docs/getting-started/introduction/): Shoal is a feature-flag and remote-config service built for TypeScript teams. Ship code dark, release it to the right people, and roll back in one click.
- [Quickstart](https://tidemark-demo.pages.dev/en/docs/getting-started/quickstart/): Create a project, install the SDK and evaluate your first flag.
- [Installation](https://tidemark-demo.pages.dev/en/docs/getting-started/installation/): Install the SDK for your runtime and framework, and configure TypeScript types.

## Core concepts

- [Flags](https://tidemark-demo.pages.dev/en/docs/concepts/flags/): Flag types, variations, defaults and how evaluation picks a value.
- [Environments](https://tidemark-demo.pages.dev/en/docs/concepts/environments/): Separate flag state per stage, with keys for servers and browsers.
- [Targeting rules](https://tidemark-demo.pages.dev/en/docs/concepts/targeting/): Serve different variations based on user attributes, segments and percentages.

## Guides

- [Next.js](https://tidemark-demo.pages.dev/en/docs/guides/nextjs/): Evaluate flags in server components, route handlers, middleware and the browser.
- [Gradual rollouts](https://tidemark-demo.pages.dev/en/docs/guides/rollouts/): Release to a growing share of users and roll back automatically when metrics drop.
- [Webhooks](https://tidemark-demo.pages.dev/en/docs/guides/webhooks/): Get notified when flags change and verify signed payloads.
- [Migrating from v1](https://tidemark-demo.pages.dev/en/docs/guides/migrate-v1/): Every breaking change between v1 and v2, with before-and-after code.

## Reference

- [CLI](https://tidemark-demo.pages.dev/en/docs/reference/cli/): Manage flags, rollouts, keys and types from your terminal and CI.
- [Configuration](https://tidemark-demo.pages.dev/en/docs/reference/configuration/): All client options and the shoal.yaml project file.
- [SDK methods](https://tidemark-demo.pages.dev/en/docs/reference/sdk/): Every method of the JavaScript SDK client.

## API reference

- [Flags](https://tidemark-demo.pages.dev/en/api/flags/): Create, read, update and delete feature flags.
- [Environments](https://tidemark-demo.pages.dev/en/api/environments/): List environments and create new ones.
- [Evaluate](https://tidemark-demo.pages.dev/en/api/evaluate/): Evaluate flags over HTTP — for languages without an SDK, or for debugging.
- [Webhooks](https://tidemark-demo.pages.dev/en/api/webhooks/): Register endpoints that receive project events.

## Optional

- [Changelog](https://tidemark-demo.pages.dev/en/changelog/): release notes for every version
- [v1.x docs](https://tidemark-demo.pages.dev/en/docs/v1/): docs for an older version