Skip to content

sitesauce/cli

master
Switch branches/tags
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
src
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

The Sitesauce CLI

Deploy sites running in your computer directly to Sitesauce

Motivation

While Sitesauce aims to remove the need for hosting the dynamic version of your website, it still requires you to host it somewhere acessible so we can generate your static sites. The Sitesauce CLI allows you to deploy your sites directly from your computer, completely removing the need for servers. While this may not be the first option for everyone (as it doesn't allow you to share an admin panel with the rest of your team), it provides for an interesting alternative, and greatly reduces the friction (and cost) of publishing a new website.

Install

To install the CLI, install it globally with npm

$ npm install --global sitesauce-cli

You can also use Yarn

$ yarn global add sitesauce-cli

Authenticating with Sitesauce

The CLI needs to authenticate with Sitesauce to deploy to your sites. You can connect your account by running the following command:

$ sitesauce login

You can get the name of the currently authenticated user with $ sitesauce user. You can get the name of the currently connected team with $ sitesauce team and change the team you're currently connected to using $ sitesauce switch.

If you want to log out, you can do so by running $ sitesauce logout.

Configuring a project

Projects associate Sitesauce sites and the directories on your machine that contain those sites. To associate a directory with a site, open that directory in your terminal and run $ sitesauce init. This will create a .sitesauce folder with your config. We'll also automatically add that folder to your .gitignore if you have one.

Deploying a project

NOTE: Make sure you've configured your project deploying it.

To deploy a project, open the project directory and run $ sitesauce deploy. This will ask you for the port your application is running in and open a secure tunnel between your computer and our server that will be closed as soon as the deployment is finished.

Customizing the Host header

Some server applications (like Laravel Valet) use the Host header to decide which site to serve. To deploy this types of applications, you can use the --host. For example, if you were to deploy a Valet site, you would have to use the following command

$ sitesauce deploy --port 80 --host laravel.test

You might also have noticed we're specifying the port via the --port flag, skipping the port prompt and making the whole process faster.

If you use port 80 but don't specify a host, you'll be asked if you want to use a virtual host.

Known limitations

If your local server uses a self-signed certificate and forces HTTPS support, there's a chance the deployment will fail. To fix it, you can temporally unsecure your site while you deploy. For example, when deploying a Valet site you've used valet secure on, you might have to run valet unsecure before deploying.

Usage

You can get a list of all available commands at any time by running the sitesauce command with no arguments

$ sitesauce

You can also get help for a specific commend by using the --help flag

$ sitesauce deploy --help

License

Licensed under the MIT license. For more information, check the license file.