Backyards CLI — once you have a basic understanding about its use — is the most effective way to use Backyards.

Backyards has a web user interface as well, which may also be your choice for getting started with the platform, but currently most examples of this documentation are for the CLI. Both the CLI and the web UI are using the same GraphQL API behind the scenes. Statements in this documentation usually apply to the web UI as well, but there are some differences. Some features are currently available only in the CLI, while some others might be available only on the web UI.

Note: The web interface supports recent releases of the Apple Safari, Google Chrome, Mozilla Firefox browsers. Use the desktop edition.

Depending on your goals, environment, preferences, and level of experience, you can use the CLI either instead of, or as a supplement to using the public GraphQL API of the platform directly, with our client library, or the web interface.

Further reading 🔗︎