{"id":20970577,"url":"https://github.com/eventonehq/rva-cli","last_synced_at":"2026-05-04T17:31:31.057Z","repository":{"id":98623901,"uuid":"93465050","full_name":"eventOneHQ/rva-cli","owner":"eventOneHQ","description":"🛠 AWS S3 Review Apps Tools CLI","archived":false,"fork":false,"pushed_at":"2019-01-05T01:51:42.000Z","size":111,"stargazers_count":3,"open_issues_count":2,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-03-02T22:17:48.418Z","etag":null,"topics":["aws","cli","gitlab","gitlab-ci","review","review-app","s3-bucket"],"latest_commit_sha":null,"homepage":"https://oss.eventone.page/rva-cli/","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/eventOneHQ.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2017-06-06T02:03:45.000Z","updated_at":"2023-04-24T13:16:02.000Z","dependencies_parsed_at":"2023-04-24T22:03:51.329Z","dependency_job_id":null,"html_url":"https://github.com/eventOneHQ/rva-cli","commit_stats":null,"previous_names":["filiosoft/rva-cli"],"tags_count":6,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eventOneHQ%2Frva-cli","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eventOneHQ%2Frva-cli/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eventOneHQ%2Frva-cli/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eventOneHQ%2Frva-cli/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/eventOneHQ","download_url":"https://codeload.github.com/eventOneHQ/rva-cli/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243365639,"owners_count":20279215,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["aws","cli","gitlab","gitlab-ci","review","review-app","s3-bucket"],"created_at":"2024-11-19T03:59:39.887Z","updated_at":"2025-12-25T18:02:59.369Z","avatar_url":"https://github.com/eventOneHQ.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# RVA-CLI [![GitHub issues](https://img.shields.io/github/issues/eventOneHQ/rva-cli.svg)](https://github.com/eventOneHQ/rva-cli/issues) [![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://raw.githubusercontent.com/eventOneHQ/rva-cli/master/LICENSE) [![npm](https://img.shields.io/npm/v/@filiosoft/rva-cli.svg)](https://www.npmjs.com/package/@filiosoft/rva-cli) [![npm](https://img.shields.io/npm/dt/@filiosoft/rva-cli.svg)](https://www.npmjs.com/package/@filiosoft/rva-cli) [![Docker Pulls](https://img.shields.io/docker/pulls/filiosoft/rva-cli.svg)](https://hub.docker.com/r/filiosoft/rva-cli) [![Codacy Badge](https://api.codacy.com/project/badge/Grade/e9965678265a4278982594d165af3c40)](https://www.codacy.com/app/nprail/rva-cli?utm_source=github.com\u0026amp;utm_medium=referral\u0026amp;utm_content=eventOneHQ/rva-cli\u0026amp;utm_campaign=Badge_Grade)\n\nAWS S3 [Review Apps](https://docs.gitlab.com/ee/ci/review_apps/index.html) Tools CLI\n\n## Installation\n\nTo install RVA-CLI, run the following:\n\n```\n$ npm i -g @filiosoft/rva-cli\n```\n\n## Usage\n```\n\n  Usage: rva [options] [command]\n\n  Example: rva start upgrade-to-angular-2\n\n\n  Commands:\n\n    start [name]  start a S3 review app\n    stop [name]   stop a S3 review app\n    init [baseName]  initialize a project with S3 review apps\n    publish [baseName]  initialize and upload a project with S3 review apps\n    help [cmd]    display help for [cmd]\n\n  Options:\n\n    -h, --help     output usage information\n    -V, --version  output the version number\n\n```\n### Configuration\nBefore using RVA, you need to create a `rva.json` file in your root project folder and set two environment variables. You can do this by running the following.\n\n```\n$ rva init [your_base_review_app_name]\n```\n\n### Publish Review App\nTo create an AWS S3 bucket for a static website review app on a git branch called `upgrade-to-angular-2` and then publish the `publicFolder`, run the following.\n\n```\n$ rva publish upgrade-to-angular-2\n```\n\nThis will do the following steps:\n\n1. Run `rva start` (see [below](#start-review-app) for what it does)\n2. Upload your `publicFolder`\n\nYou will then be able to browse to the following to view the review app:\n[http://upgrade-to-angular-2.review.example.com.s3-website-us-east-1.amazonaws.com](http://upgrade-to-angular-2.review.example.com.s3-website-us-east-1.amazonaws.com)\n\n### Start Review App\n_If you are using `rva publish` you do not need to start the review app_\n\nTo create an AWS S3 bucket for a static website review app on a git branch called `upgrade-to-angular-2`, run the following.\n\n```\n$ rva start upgrade-to-angular-2\n```\nThis will do the following steps:\n\n1. Create an S3 bucket\n2. Set the bucket policy\n3. Enable static website hosting in the bucket\n\nYou will then be able to upload your website to the bucket!\n\n### Delete Review App\nTo delete the S3 review app you created above, run the following.\n\n```\n$ rva stop upgrade-to-angular-2\n```\n\nThis will delete app files in the bucket and the bucket itself.\n\n### Example `.gitlab-ci.yml` With RVA-CLI\n\n```yaml\nstages:\n  - build\n  - deploy\n\nvariables:\n  BASE_DOMAIN: \"review.example.com\" # Should be the same as the configured base domain\n\nbuild:\n  stage: build\n  tags: \n  - docker\n  image: node:8\n  script:\n  - npm build\n  artifacts:\n    paths:\n    - public\n\nstart_review:\n  stage: deploy\n  tags: \n  - docker\n  image: filiosoft/rva-cli:latest\n  dependencies:\n  - build\n  script:\n  - rva publish ${CI_ENVIRONMENT_SLUG}\n  environment:\n    name: review/${CI_BUILD_REF_NAME}\n    url: http://${CI_ENVIRONMENT_SLUG}.${BASE_DOMAIN}\n  artifacts:\n    paths:\n    - public\n\nstop_review:\n  stage: deploy\n  tags: \n  - docker\n  image: filiosoft/rva-cli:latest\n  script:\n    - rva stop ${CI_ENVIRONMENT_SLUG}\n  when: manual\n  environment:\n    name: review/${CI_BUILD_REF_NAME}\n    action: stop\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Feventonehq%2Frva-cli","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Feventonehq%2Frva-cli","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Feventonehq%2Frva-cli/lists"}