Skip to content

Commit

Permalink
Explain the usage in the readme
Browse files Browse the repository at this point in the history
  • Loading branch information
itmarck committed Nov 15, 2022
1 parent 1542cd3 commit 553bb42
Showing 1 changed file with 53 additions and 1 deletion.
54 changes: 53 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,4 +14,56 @@ curl https://raw.githubusercontent.com/itmarck/deploy.sh/main/install.sh | bash

## Usage

TBD
```
Usage: deploy [OPTION]... [REPOSITORY]...
```

### Guide to use

Basic instructions to start using the command.

```bash
# List available repositories
deploy

# Add a repository where REPOSITORY is the path to the repository
deploy --add REPOSITORY

# Run a deployment file by repository name
# To specify the deployment file, use the --file option
deploy REPOSITORY

# Remove a repository by name
deploy --remove REPOSITORY

# Remove all repositories
deploy --clean

# Show command version
deploy --version

# Show command help
deploy --help
```

### Flags

Available flags to use with the command.

```
-a, --add Add REPOSITORY to the list
-c, --clean Clean all repositories
-f, --file Specify the deployment filename (default: deploy.sh)
-r, --remove Remove the REPOSITORY
-v, --verbose Print verbose output
--help Show this help information
--version Show command version
```

## Updating

The installation process use a detailed copy of the repository and it doesn't override the data storaged. So you can safely update by running the `install.sh` file again or by running the installation command specified above.

## Uninstalling

To uninstall the command, just remove the `deploy` file and the `.deploy` folder from `/usr/local/bin` folder.

0 comments on commit 553bb42

Please sign in to comment.