ℹī¸About

What is the CLI and Why use it?

Siteglide CLI (Command Line Interface) is a tool that enables you to work on your project from your local IDE or Code Editor; it has similar behaviours to FTP (File Transfer Protocol), in that you can sync up and pull down changes from your website.

Who is it for?

Developers will be at home with the Siteglide CLI. It allows them to work faster than they can using the User Interface of the website. It also allows them to access the full suite of time-saving extensions and search tools in IDEs like VSCode and Atom.

But it's not just for Developers! Designers, SEO specialists and Agency Leaders may also find benefits to learning and using Siteglide CLI - allowing them to see an overview over their entire project and quickly find the files they're looking for.

How to Navigate Around?

Check the "File Structure" in each documentation topic, and this will help you find your way around the folders and files.

Benefits of CLI over FTP:

Validation

With CLI, we can validate code sent to the site. This is especially useful if you are syncing Liquid or GraphQL code where there are fewer 3rd party tools for linting. If there is a problem we can pick up automatically- the sync will fail and an error message will try to help you find the problem.

Version Control

With Siteglide CLI we can keep track of the Code pushed to the Site from Admin and from local machines and make sure the Site always contains the most up to date pushes. It gives us scope to improve this functionality in the future.

Developer Tools

Other CLI commands like siteglide-cli graphql and siteglide-cli logs provide developers with advanced tools that would not be available with an FTP.

Ready to Start Using CLI?

🚀Quickstart: CLI

Last updated