https://github.com/andreybleme/theros

A simple and reliable tool to deploy static websites
https://github.com/andreybleme/theros

cli deployment s3 static-site

Last synced: 2 months ago
JSON representation

A simple and reliable tool to deploy static websites

• Host: GitHub
• URL: https://github.com/andreybleme/theros
• Owner: andreybleme
• License: mit
• Created: 2019-02-21T23:11:13.000Z (about 7 years ago)
• Default Branch: master
• Last Pushed: 2020-11-11T22:44:19.000Z (over 5 years ago)
• Last Synced: 2025-10-23T10:56:41.975Z (5 months ago)
• Topics: cli, deployment, s3, static-site
• Language: JavaScript
• Homepage: https://npmjs.com/package/theros
• Size: 21.5 KB
• Stars: 2
• Watchers: 1
• Forks: 1
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

          
# theros

[![Build Status](https://travis-ci.com/andreybleme/theros.svg?branch=master)](https://travis-ci.com/andreybleme/theros)

A simple and reliable tool to deploy static websites.

## What is theros?

Theros is a CLI tool to deploy static websites. It takes a website and upload it to an s3 bucket.

You can use `theros` to quickly create a new s3 bucket with the proper static website hosting configuration with a single command.

## Why

We need an alternative to manually uploading static websites to s3 buckets and repeatidly configuring its hosting policies. 

Some of the tools I found around to do so, was either not mantained anymore, or not fast/simple enought.

> [Here I shared some insights](https://dev.to/andreybleme/theros-the-cli-tool-to-deploy-static-websites-3p76) from the process of building this tool.

## Installation

> npm install -g theros

### Testing

> npm run test

## Usage

You need to have your AWS account credentials: Access Key and Client Secret. 

If you don't have it, check [how to get your AWS security credentials](https://aws.amazon.com/pt/blogs/security/wheres-my-secret-access-key/).

#### Create

This command create a bucket pointing to `index.html` as the default root page, and `404.html` as the default error page.

> theros create --bucket  --key  --secret 

  

To create a bucket in a specific region (default is us-east-1), you can use `--region` parameter:

> theros create --bucket  --key  --secret  --region 

  

To define custom index and/or error page (default is index.html and error.html), you can use `--index` and `--error` parameters:

> theros create --bucket  --key  --secret  --index  --error 

#### Deploy

Then you can deploy your site:

> theros deploy --bucket  --key  --secret 

  

  If your files are in a different folder, you can use `--root` parameter:

  

> theros deploy --bucket  --key  --secret  --root /user/folder

  

  If you want to ignore files, that is, do not deploy them, you can use `--ignore` parameter:

  

> theros deploy --bucket  --key  --secret  --ignore 404.html,403.html

  

  

  ## License

  

  [MIT](https://github.com/andreybleme/theros/blob/master/LICENSE.md)