Skip to Page NavigationSkip to Page NavigationSkip to Content

Developer Docs

Using Keystone 5? Find the docs at v5.keystonejs.com
Need answers to Keystone questions? Get help in ourCommunity Slack
Looking for enterprise-grade consulting & support?Learn more

The Keystone Experience

Discover the vision behind Keystone and what it's like to work with. If you’ve just heard of Keystone, start here first:

Walkthroughs

Step-by-step instructions for getting things done with Keystone.

Guides

Practical explanations of Keystone’s fundamental building blocks. When you’re trying to get something done, Keystone guides show you how to think about, and get the most out of each feature.

Command Line Foundations

Keystone’s CLI helps you develop, build, and deploy projects. This guide explains all you need to standup a new backend in the terminal.

Understanding Relationships

Learn how to reason about and configure relationships in Keystone, so you can bring value to your project through structured content.

GraphQL Queries - Filters

Query filters are an integral part of Keystone’s powerful GraphQL APIs. This guide will show you how to use filters to get the data you need from your system.

Understanding Hooks

Learn how to use Hooks within your schema to extend Keystone’s powerful CRUD GraphQL APIs with your own business logic.

How To Use Document Fields

Keystone’s document field is a highly customisable rich text editor that stores content as structured JSON. Learn how to configure it and incorporate your own custom React components.

Document Field Demo

Test drive the many features of Keystone’s Document field on this website.

Custom Fields

Learn how to define your own custom field types in Keystone, with customisable backend data structure, and Admin UI appearance.

Testing Guide

Learn how to test the behaviour of your Keystone system to ensure it does what you expect.

Virtual Fields

Virtual fields offer a powerful way to extend your GraphQL API. This guide introduces the syntax and shows you how start simply and end up with a complex result.

Choosing a Database

Keystone supports Postgres, MySQL and SQLite. This guide explains how to choose the best for your project.

Images and Files

Learn how to store and manage Images and Files in Keystone.

Example Projects

A growing collection of projects you can run locally to learn more about Keystone features. Use these as a reference for best practice, and a jumping off point when adding features to your own Keystone project. View on Github →

A map of our awesome contributors

Learn with others in a supportive community

Share your work and get the help you need in the Keystone community Slack: an inclusive space to share ideas and explore what‘s possible.

Join the community Slack
  • 2500+ members
  • Personalised support