Effect Documentation

Documentation for Effect, the missing standard library for TypeScript.

This documentation covers:

• Core Effect concepts and patterns
• Module API references
• Unstable modules (HTTP, CLI, AI, Cluster, etc.)
• Platform packages (Node.js, Browser, Bun)
• SQL integrations
• Migration guides from v3 to v4

Get started with Effect

Development

Install the Mintlify CLI to preview your documentation changes locally. To install, use the following command:

npm i -g mint

Run the following command at the root of your documentation, where your docs.json is located:

mint dev

View your local preview at http://localhost:3000.

Publishing changes

Install our GitHub app from your dashboard to propagate changes from your repo to your deployment. Changes are deployed to production automatically after pushing to the default branch.

Need help?

Troubleshooting

• If your dev environment isn't running: Run mint update to ensure you have the most recent version of the CLI.
• If a page loads as a 404: Make sure you are running in a folder with a valid docs.json.

Resources

• Mintlify documentation