Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/HugoRCD/shelve
Shelve, is a project management tool for developer to make project creation and management easier
https://github.com/HugoRCD/shelve
cli env environment-variables git monorepo nuxt project-management secrets-management typescript variables vercel vuejs
Last synced: about 1 month ago
JSON representation
Shelve, is a project management tool for developer to make project creation and management easier
- Host: GitHub
- URL: https://github.com/HugoRCD/shelve
- Owner: HugoRCD
- License: apache-2.0
- Created: 2024-02-27T13:51:42.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2024-11-06T17:42:08.000Z (about 2 months ago)
- Last Synced: 2024-11-07T09:21:25.480Z (about 2 months ago)
- Topics: cli, env, environment-variables, git, monorepo, nuxt, project-management, secrets-management, typescript, variables, vercel, vuejs
- Language: Vue
- Homepage: https://shelve.cloud
- Size: 11 MB
- Stars: 58
- Watchers: 2
- Forks: 1
- Open Issues: 24
-
Metadata Files:
- Readme: README.md
- Funding: .github/funding.yml
- License: LICENSE
Awesome Lists containing this project
- jimsghstars - HugoRCD/shelve - All-in-one development workspace for managing environments and collaborating on projects. (Vue)
README
# Shelve
[](https://npmjs.com/package/@shelve/cli)
[](https://npm.chart.dev/@shelve/cli)
[](https://github.com/HugoRCD/shelve/blob/main/LICENSE)
The Shelve CLI serves as a command-line interface designed for the [Shelve](https://shelve.cloud/) platform. This tool enables users to authenticate with Shelve, facilitating the seamless transfer of environment variables for project collaboration within a team directly through the terminal interface.
## Installation
Install the package locally:
```sh
bun a -d @shelve/cli
```
## Configuration
Configuration is loaded by [unjs/c12](https://github.com/unjs/c12) from cwd. You can use either `shelve.config.json`, `shelve.config.{ts,js,mjs,cjs}` or use the `shelve` field in `package.json`.
You have the option to create a `shelve.config.ts` file to enable type checking and autocompletion. The file should contain the following content:
```ts title="shelve.config.ts"
import { createShelveConfig } from "@shelve/cli"
export default createShelveConfig({
project: "my-project", // only required field
token: "my-token",
url: "https://shelve.cloud",
confirmChanges: false,
pushMethod: 'overwrite',
pullMethod: 'overwrite',
envFileName: '.env',
autoUppercase: true,
})
```
The CLI also has a json schema for the configuration file. that can be used to validate the configuration file. (see it [here](https://raw.githubusercontent.com/HugoRCD/shelve/main/packages/types/shelve-config-schema.json))
## Usage
```bash
Usage: shelve [options] [command]
The command-line interface for Shelve
Options:
-V, --version output the version number
-h, --help display help for command
Commands:
create|c [options] Create a new project
pull|pl [options] Pull variables for specified environment to .env file
push|ps [options] Push variables for specified environment to Shelve
generate|g Generate resources for a project
upgrade|u Upgrade the Shelve CLI to the latest version
config|cf Show the current configuration
help [command] display help for command
```
Local development
- Clone this repository
- Install latest LTS version of [Node.js](https://nodejs.org/en/)
- Enable [Corepack](https://github.com/nodejs/corepack) using `corepack enable`
- Install dependencies using `bun install`
## Self-Hosting with Docker
To self-host the Shelve application using the Docker image available on GitHub, follow these steps:
1. **Pull the Docker Image**:
```sh
docker pull ghcr.io/hugorcd/shelve:latest
```
2. **Run the Docker Container**:
```sh
docker run -d -p 8080:80 --name shelve-app ghcr.io/hugorcd/shelve:latest
```
3. **Access the Application**:
Open your browser and navigate to `http://localhost:8080` to access the Shelve application.
Ensure you have Docker installed and running on your machine before executing these commands. For more information on Docker, refer to the [official Docker documentation](https://docs.docker.com/get-docker/).
## Self-Hosting with docker-compose
To self-host the Shelve application using the community `docker-compose` configuration, follow these steps:
1. **Clone the Repository**:
```sh
git clone https://github.com/HugoRCD/shelve.git
cd shelve
```
2. **Copy the Example Environment File**:
```sh
cp apps/shelve/.env.example apps/shelve/.env
```
3. **Update Environment Variables**:
Edit the `apps/shelve/.env` file and update the necessary environment variables.
4. **Run docker-compose**:
```sh
docker-compose -f docker-compose.community.yml up -d
```
5. **Access the Application**:
Open your browser and navigate to `http://localhost:3000` to access the Shelve application.
Ensure you have Docker and docker-compose installed and running on your machine before executing these commands. For more information on Docker and docker-compose, refer to the official Docker documentation.
## Contributing
To start contributing, you can follow these steps:
1. First raise an issue to discuss the changes you would like to make.
2. Fork the repository.
3. Create a branch using conventional commits and the issue number as the branch name. For example, `feat/123` or `fix/456`.
4. Make changes following the local development steps.
5. Commit your changes following the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) specification.
6. If your changes affect the code, run tests using `bun run test`.
7. Create a pull request following the [Pull Request Template](https://github.com/HugoRCD/markdown/blob/main/src/pull_request_template.md).
- To be merged, the pull request must pass the tests/workflow and have at least one approval.
- If your changes affect the documentation, make sure to update it.
- If your changes affect the code, make sure to update the tests.
8. Wait for the maintainers to review your pull request.
9. Once approved, the pull request will be merged in the next release !
Published under the [APACHE](https://github.com/HugoRCD/shelve/blob/main/LICENSE) license.
Made by [@HugoRCD](https://github.com/HugoRCD), [@CavallucciJohann](https://github.com/CavallucciJohann) and [community](https://github.com/HugoRCD/shelve/graphs/contributors) 💛
---
_🤖 auto updated with [automd](https://automd.unjs.io) (last updated: Fri Oct 11 2024)_