Shelve, is a project management tool for developer to make project creation and management easier
APACHE-2.0 License
The Shelve CLI serves as a command-line interface designed for the Shelve 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.
Install the package globally:
npm install -g @shelve/cli
Configuration is loaded by 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:
import { createShelveConfig } from "@shelve/cli"
export default createShelveConfig({
project: "my-project", // only required field
token: "my-token",
url: "https://shelve.hrcd.fr",
confirmChanges: false,
pushMethod: 'overwrite',
pullMethod: 'overwrite',
envFileName: '.env',
})
The CLI also has a json schema for the configuration file. that can be used to validate the configuration file. (see it here)
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
corepack enable
bun install
To start contributing, you can follow these steps:
feat/123
or fix/456
.bun run test
.Published under the APACHE license. Made by @HugoRCD, @CavallucciJohann and community π
π€ auto updated with automd (last updated: Tue Oct 08 2024)