Skip to content

Commit

Permalink
docs: update main readme
Browse files Browse the repository at this point in the history
  • Loading branch information
HugoRCD committed Mar 31, 2024
1 parent 60fda92 commit fca5c09
Showing 1 changed file with 17 additions and 15 deletions.
32 changes: 17 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,21 +11,23 @@ npm install -g @shelve/cli
## Usage

```bash
USAGE shelve upgrade|login|logout|whoami|pull|push

COMMANDS

upgrade Upgrade the Shelve CLI to the latest version
link Link the current directory with a Shelve project
unlink Unlink the current directory from a Shelve project
login Authenticate with Shelve
logout Logout the current authenticated user
whoami Shows the username of the currently logged in user
pull Retrieve the environement variables from Shelve
push Send the environement variables to Shelve
open Open the current project in the browser

Use shelve <command> --help for more information about a command.
USAGE shelve <command|shortcut> [options]

| Commands | Description | Shortcut |
|----------|------------------------------------------------------|-----------|
| create | Create a new Shelve project | c |
| init | alias for create | i |
| upgrade | Upgrade the Shelve CLI to the latest version | u |
| 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 |
| open | Open the current project in the browser | o |

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

<!-- automd:fetch url="gh:hugorcd/markdown/main/src/local_development.md" -->
Expand Down

0 comments on commit fca5c09

Please sign in to comment.