Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
  • Loading branch information
Siddheshk02 committed Nov 27, 2023
2 parents 1b2384c + 02d4a09 commit 1feb734
Show file tree
Hide file tree
Showing 2 changed files with 208 additions and 1 deletion.
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2023 Siddhesh Khandagale

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
188 changes: 187 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1 +1,187 @@
# Securelee-cli
# Securelee Vault

[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
![](https://img.shields.io/github/go-mod/go-version/Siddheshk02/Securelee-cli)
![](https://img.shields.io/github/downloads-pre/Siddheshk02/Securelee-cli/v1.0.5/total)

A Open Source CLI tool built using Golang and Pangea for Storing and Managing Sensitive secrets and Keys.


## 💻 Tech Stack :
- [Golang](https://go.dev/)
- [Pangea](https://pangea.cloud/)

## 🛠️ Installation :

### Requirements :
- Golang ( version >= 1.20 ) [Installation Guide](https://golangdocs.com/install-go-windows)


Run this command to install Securelee :
```
go install github.com/Siddheshk02/Securelee-cli@v1.0.5
```

Start with Securelee :
```
Securelee-cli
```

## 📌 Commands :
<!-- commands -->

* [`Securelee-cli [command] --help`](#Securelee-cli-help)
* [`Securelee-cli create`](#Securelee-cli-create)
* [`Securelee-cli login`](#Securelee-cli-login)
* [`Securelee-cli update`](#Securelee-cli-update)
* [`Securelee-cli get`](#Securelee-cli-get)
* [`Securelee-cli list`](#Securelee-cli-list)
* [`Securelee-cli version`](#Securelee-cli-version)
* [`Securelee-cli delete`](#Securelee-cli-delete)
* [`Securelee-cli whoami`](#Securelee-cli-whoami)
* [`Securelee-cli logout`](#Securelee-cli-logout)

## `Securelee-cli [command] --help`

```
> Securelee-cli --help
A CLI based Vault App for storing your Secret Messages or Keys Securely.
Usage:
Securelee-cli [flags]
Securelee-cli [command]
Available Commands:
completion Generate the autocompletion script for the specified shell
create Create and Store a Secret Message or Key.
delete Delete a Secret Message or Key.
get Get a Particular Secret or Key.
help Help about any command
list Get all Secret Messages or Keys.
login Login to Securelee Vault.
logout Logout of Securelee Vault.
update Update or Modify a Secret Message or Key.
version Version of the Securelee CLI.
whoami The Current User of Securelee Vault.
Flags:
-h, --help help for Securelee-cli
-t, --toggle Help message for toggle
-v, --version version for Securelee-cli
Use "Securelee-cli [command] --help" for more information about a command.
```

## `Securelee-cli create`

```
Create and Store a Secret Messages or Keys.
Usage:
Securelee-cli create [flags]
Flags:
-h, --help help for create
```

## `Securelee-cli login`

```
Login to Securelee Vault.
Usage:
Securelee-cli login [flags]
Flags:
-h, --help help for login
```

## `Securelee-cli update`

```
Update or Modify a Secret Message or Key.
Usage:
Securelee-cli update [flags]
Flags:
-h, --help help for update
```

## `Securelee-cli get`

```
Get a Particular Secret or Key.
Usage:
Securelee-cli get [flags]
Flags:
-h, --help help for get
```

## `Securelee-cli list`

```
Get all Secret Messages or Keys.
Usage:
Securelee-cli list [flags]
Flags:
-h, --help help for list
```

## `Securelee-cli version`

```
Version of the Securelee CLI.
Usage:
Securelee-cli version [flags]
Flags:
-h, --help help for version
```

## `Securelee-cli delete`

```
Delete a Secret Message or Key.
Usage:
Securelee-cli delete [flags]
Flags:
-h, --help help for delete
```

## `Securelee-cli whoami`

```
The Current User of Securelee Vault.
Usage:
Securelee-cli whoami [flags]
Flags:
-h, --help help for whoami
```

## `Securelee-cli logout`

```
Logout of Securelee Vault.
Usage:
Securelee-cli logout [flags]
Flags:
-h, --help help for logout
```

## Support
Do support by giving a 🌟 to Securelee Vault.

0 comments on commit 1feb734

Please sign in to comment.