Shelve CLI

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.

Installation

Install the package globally:

npm install -g @shelve/cli

Usage

USAGE shelve <command|shortcut> [options]

| Commands | Description                                          | Shortcut  |
|----------|------------------------------------------------------|-----------|
| create   | Create a new Shelve project                          | c         |
| init     | alias for create                                     | i         |
| link     | Link the current directory with a Shelve project     | l         |
| unlink   | Unlink the current directory from a Shelve project   | ul        |
| login    | Authenticate with Shelve                             | li        |
| logout   | Logout the current authenticated user                | lo        |
| whoami   | Shows the username of the currently logged-in user   | w         |
| pull     | Retrieve the environment variables from Shelve       | pl        |
| push     | Send the environment variables to Shelve             | ps        |

Use shelve <command|shortcut> --help for more information about a command.

Local development

• Clone this repository
• Install latest LTS version of Node.js
• Enable Corepack using corepack enable
• Install dependencies using bun install

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 specification.
6. If your changes affect the code, run tests using bun run test.
7. Create a pull request following the Pull Request Template.
   • 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 license. Made by @HugoRCD and community 💛

---

🤖 auto updated with automd (last updated: Tue Aug 27 2024)