From 327cd535dd4639b163f54cef120a65461fe3d1c3 Mon Sep 17 00:00:00 2001 From: Ojaswa Sharma Date: Mon, 14 Feb 2022 20:31:17 +0530 Subject: [PATCH] docs: move assets, duplicate content to gitbook --- README.md | 6 ++-- ...-_9KEyP6CHSl4tQuW7Z_lH4ujp1AYYacGA (1).png | Bin .../assets/01 Initial Screen (1).png | Bin .../.gitbook}/assets/Base (1) (1).png | Bin .../.gitbook}/assets/Base (2) (1).png | Bin .../.gitbook}/assets/Base (3) (1).png | Bin .../.gitbook}/assets/Base (4) (1) (1).png | Bin .../.gitbook}/assets/Base (4) (1).png | Bin .../.gitbook}/assets/Base (5) (1).png | Bin .../.gitbook}/assets/Base (6) (1).png | Bin .../.gitbook}/assets/Base (7) (1).png | Bin .../.gitbook}/assets/Base (8).png | Bin .../assets/Initial Summary (1) (1).png | Bin .../.gitbook}/assets/Initial Summary (2).png | Bin ...-fVyUEHfYniZZMuPGhK7Os3Sfi5R-g (1) (1).png | Bin ...Tw_4-fVyUEHfYniZZMuPGhK7Os3Sfi5R-g (1).png | Bin .../assets/image-20220212-135442 (1).png | Bin .../assets/image-20220212-135442.png | Bin .../assets/image-20220212-135522.png | Bin .../assets/image-20220212-135602.png | Bin .../assets/image-20220212-135813.png | Bin .../assets/image-20220212-135838.png | Bin .../assets/image-20220212-135919.png | Bin docs/privado-cli/authenticate-privado.md | 20 ++++++++--- docs/privado-cli/getting-started-with-cli.md | 5 +-- docs/privado-cli/installing-privado-cli.md | 34 ++++++++++++++++++ docs/privado-cli/scan-results.md | 4 +-- 27 files changed, 55 insertions(+), 14 deletions(-) rename {.gitbook => docs/.gitbook}/assets/-_9KEyP6CHSl4tQuW7Z_lH4ujp1AYYacGA (1).png (100%) rename {.gitbook => docs/.gitbook}/assets/01 Initial Screen (1).png (100%) rename {.gitbook => docs/.gitbook}/assets/Base (1) (1).png (100%) rename {.gitbook => docs/.gitbook}/assets/Base (2) (1).png (100%) rename {.gitbook => docs/.gitbook}/assets/Base (3) (1).png (100%) rename {.gitbook => docs/.gitbook}/assets/Base (4) (1) (1).png (100%) rename {.gitbook => docs/.gitbook}/assets/Base (4) (1).png (100%) rename {.gitbook => docs/.gitbook}/assets/Base (5) (1).png (100%) rename {.gitbook => docs/.gitbook}/assets/Base (6) (1).png (100%) rename {.gitbook => docs/.gitbook}/assets/Base (7) (1).png (100%) rename {.gitbook => docs/.gitbook}/assets/Base (8).png (100%) rename {.gitbook => docs/.gitbook}/assets/Initial Summary (1) (1).png (100%) rename {.gitbook => docs/.gitbook}/assets/Initial Summary (2).png (100%) rename {.gitbook => docs/.gitbook}/assets/Tw_4-fVyUEHfYniZZMuPGhK7Os3Sfi5R-g (1) (1).png (100%) rename {.gitbook => docs/.gitbook}/assets/Tw_4-fVyUEHfYniZZMuPGhK7Os3Sfi5R-g (1).png (100%) rename {.gitbook => docs/.gitbook}/assets/image-20220212-135442 (1).png (100%) rename {.gitbook => docs/.gitbook}/assets/image-20220212-135442.png (100%) rename {.gitbook => docs/.gitbook}/assets/image-20220212-135522.png (100%) rename {.gitbook => docs/.gitbook}/assets/image-20220212-135602.png (100%) rename {.gitbook => docs/.gitbook}/assets/image-20220212-135813.png (100%) rename {.gitbook => docs/.gitbook}/assets/image-20220212-135838.png (100%) rename {.gitbook => docs/.gitbook}/assets/image-20220212-135919.png (100%) diff --git a/README.md b/README.md index af7f3c45..40598f8e 100644 --- a/README.md +++ b/README.md @@ -34,7 +34,7 @@ Privacy Engineers can use our CLI tool as an MRI for products, applications and To start off, make sure `docker` is installed. To install docker, you can follow the steps stated in the [official documentation](https://docs.docker.com/engine/install/). You can install Privado CLI in multiple manners: -- [Using `curl` or `wget`](#install-using-curl-or-wget) +- [Using `curl`](#install-using-curl) - [Using `go`](#install-using-go) - [Using releases](#install-release-manually) @@ -49,7 +49,7 @@ curl -o- https://raw.githubusercontent.com/Privado-Inc/privado/main/install.sh | To uninstall, simply delete `~/.privado/bin`. ### Install using Go -If you are a GoLang fan, you can use the `go install` to install the Privado CLI: +If you are a GoLang fan, you can use the `go install` command to install the Privado CLI: ``` go install github.com/Privado-Inc/privado@latest @@ -93,7 +93,7 @@ To scan a repository, simply run: ``` privado scan ``` -Depending on repository size and system configuration, scanning can take upto 5-10 minutes. Post completion, the results can be viewed on [localhost:3000](http://localhost:3000). +Depending on repository size and system configuration, time to scan can vary. Post completion, the results can be viewed on [localhost:3000](http://localhost:3000). privado-scan-completion-snapshot diff --git a/.gitbook/assets/-_9KEyP6CHSl4tQuW7Z_lH4ujp1AYYacGA (1).png b/docs/.gitbook/assets/-_9KEyP6CHSl4tQuW7Z_lH4ujp1AYYacGA (1).png similarity index 100% rename from .gitbook/assets/-_9KEyP6CHSl4tQuW7Z_lH4ujp1AYYacGA (1).png rename to docs/.gitbook/assets/-_9KEyP6CHSl4tQuW7Z_lH4ujp1AYYacGA (1).png diff --git a/.gitbook/assets/01 Initial Screen (1).png b/docs/.gitbook/assets/01 Initial Screen (1).png similarity index 100% rename from .gitbook/assets/01 Initial Screen (1).png rename to docs/.gitbook/assets/01 Initial Screen (1).png diff --git a/.gitbook/assets/Base (1) (1).png b/docs/.gitbook/assets/Base (1) (1).png similarity index 100% rename from .gitbook/assets/Base (1) (1).png rename to docs/.gitbook/assets/Base (1) (1).png diff --git a/.gitbook/assets/Base (2) (1).png b/docs/.gitbook/assets/Base (2) (1).png similarity index 100% rename from .gitbook/assets/Base (2) (1).png rename to docs/.gitbook/assets/Base (2) (1).png diff --git a/.gitbook/assets/Base (3) (1).png b/docs/.gitbook/assets/Base (3) (1).png similarity index 100% rename from .gitbook/assets/Base (3) (1).png rename to docs/.gitbook/assets/Base (3) (1).png diff --git a/.gitbook/assets/Base (4) (1) (1).png b/docs/.gitbook/assets/Base (4) (1) (1).png similarity index 100% rename from .gitbook/assets/Base (4) (1) (1).png rename to docs/.gitbook/assets/Base (4) (1) (1).png diff --git a/.gitbook/assets/Base (4) (1).png b/docs/.gitbook/assets/Base (4) (1).png similarity index 100% rename from .gitbook/assets/Base (4) (1).png rename to docs/.gitbook/assets/Base (4) (1).png diff --git a/.gitbook/assets/Base (5) (1).png b/docs/.gitbook/assets/Base (5) (1).png similarity index 100% rename from .gitbook/assets/Base (5) (1).png rename to docs/.gitbook/assets/Base (5) (1).png diff --git a/.gitbook/assets/Base (6) (1).png b/docs/.gitbook/assets/Base (6) (1).png similarity index 100% rename from .gitbook/assets/Base (6) (1).png rename to docs/.gitbook/assets/Base (6) (1).png diff --git a/.gitbook/assets/Base (7) (1).png b/docs/.gitbook/assets/Base (7) (1).png similarity index 100% rename from .gitbook/assets/Base (7) (1).png rename to docs/.gitbook/assets/Base (7) (1).png diff --git a/.gitbook/assets/Base (8).png b/docs/.gitbook/assets/Base (8).png similarity index 100% rename from .gitbook/assets/Base (8).png rename to docs/.gitbook/assets/Base (8).png diff --git a/.gitbook/assets/Initial Summary (1) (1).png b/docs/.gitbook/assets/Initial Summary (1) (1).png similarity index 100% rename from .gitbook/assets/Initial Summary (1) (1).png rename to docs/.gitbook/assets/Initial Summary (1) (1).png diff --git a/.gitbook/assets/Initial Summary (2).png b/docs/.gitbook/assets/Initial Summary (2).png similarity index 100% rename from .gitbook/assets/Initial Summary (2).png rename to docs/.gitbook/assets/Initial Summary (2).png diff --git a/.gitbook/assets/Tw_4-fVyUEHfYniZZMuPGhK7Os3Sfi5R-g (1) (1).png b/docs/.gitbook/assets/Tw_4-fVyUEHfYniZZMuPGhK7Os3Sfi5R-g (1) (1).png similarity index 100% rename from .gitbook/assets/Tw_4-fVyUEHfYniZZMuPGhK7Os3Sfi5R-g (1) (1).png rename to docs/.gitbook/assets/Tw_4-fVyUEHfYniZZMuPGhK7Os3Sfi5R-g (1) (1).png diff --git a/.gitbook/assets/Tw_4-fVyUEHfYniZZMuPGhK7Os3Sfi5R-g (1).png b/docs/.gitbook/assets/Tw_4-fVyUEHfYniZZMuPGhK7Os3Sfi5R-g (1).png similarity index 100% rename from .gitbook/assets/Tw_4-fVyUEHfYniZZMuPGhK7Os3Sfi5R-g (1).png rename to docs/.gitbook/assets/Tw_4-fVyUEHfYniZZMuPGhK7Os3Sfi5R-g (1).png diff --git a/.gitbook/assets/image-20220212-135442 (1).png b/docs/.gitbook/assets/image-20220212-135442 (1).png similarity index 100% rename from .gitbook/assets/image-20220212-135442 (1).png rename to docs/.gitbook/assets/image-20220212-135442 (1).png diff --git a/.gitbook/assets/image-20220212-135442.png b/docs/.gitbook/assets/image-20220212-135442.png similarity index 100% rename from .gitbook/assets/image-20220212-135442.png rename to docs/.gitbook/assets/image-20220212-135442.png diff --git a/.gitbook/assets/image-20220212-135522.png b/docs/.gitbook/assets/image-20220212-135522.png similarity index 100% rename from .gitbook/assets/image-20220212-135522.png rename to docs/.gitbook/assets/image-20220212-135522.png diff --git a/.gitbook/assets/image-20220212-135602.png b/docs/.gitbook/assets/image-20220212-135602.png similarity index 100% rename from .gitbook/assets/image-20220212-135602.png rename to docs/.gitbook/assets/image-20220212-135602.png diff --git a/.gitbook/assets/image-20220212-135813.png b/docs/.gitbook/assets/image-20220212-135813.png similarity index 100% rename from .gitbook/assets/image-20220212-135813.png rename to docs/.gitbook/assets/image-20220212-135813.png diff --git a/.gitbook/assets/image-20220212-135838.png b/docs/.gitbook/assets/image-20220212-135838.png similarity index 100% rename from .gitbook/assets/image-20220212-135838.png rename to docs/.gitbook/assets/image-20220212-135838.png diff --git a/.gitbook/assets/image-20220212-135919.png b/docs/.gitbook/assets/image-20220212-135919.png similarity index 100% rename from .gitbook/assets/image-20220212-135919.png rename to docs/.gitbook/assets/image-20220212-135919.png diff --git a/docs/privado-cli/authenticate-privado.md b/docs/privado-cli/authenticate-privado.md index ee6b0c09..cd2dbb3d 100644 --- a/docs/privado-cli/authenticate-privado.md +++ b/docs/privado-cli/authenticate-privado.md @@ -1,5 +1,17 @@ -# Authenticate Privado +# Authenticate Privado -{% hint style="info" %} -**Good to know:** your product docs aren't just a reference of all your features! use them to encourage folks to perform certain actions and discover the value in your product. -{% endhint %} +Privado CLI requires a license key to run scans. To generate a license, run the following command: +``` +privado auth +``` +A copy of the license will be emailed to you. + +To authenticate and bootstrap the app using the generated license, run: +``` +privado bootstrap +``` + +and done! You are all set to scan your projects and generate compliance reports. + +> Please note that generated licenses are valid for 1 year from the date of issue. +> For more information about licensing, feel free to get in touch with us on [Slack](https://join.slack.com/t/devprivops/shared_invite/zt-yk5zcxh3-gj8sS9w6SvL5lNYZLMbIpw) or [Email](mailto:support@privado.ai). diff --git a/docs/privado-cli/getting-started-with-cli.md b/docs/privado-cli/getting-started-with-cli.md index b1a06838..840f2b4a 100644 --- a/docs/privado-cli/getting-started-with-cli.md +++ b/docs/privado-cli/getting-started-with-cli.md @@ -6,10 +6,7 @@ After you have authenticated you can run your first scan. ## Scan your project -Once you have authenticated, change to the project you want to scan and run `privado scan` - -IMAGE of Scan - +Once you have authenticated, simply run `privado scan `. Once the scan finishes, we will open the result in your browser. ## Scan Results diff --git a/docs/privado-cli/installing-privado-cli.md b/docs/privado-cli/installing-privado-cli.md index 31c3964a..bfdf0da7 100644 --- a/docs/privado-cli/installing-privado-cli.md +++ b/docs/privado-cli/installing-privado-cli.md @@ -1,5 +1,39 @@ # Installing Privado CLI +To start off, make sure `docker` is installed. To install docker, you can follow the steps stated in the [official documentation](https://docs.docker.com/engine/install/). You can install Privado CLI in multiple manners: + +- [Using `curl`](#install-using-curl) +- [Using `go`](#install-using-go) +- [Using releases](#install-release-manually) + + +## Install using `curl`: +The installation script will download and setup the latest stable release for you as per your OS and arch. Run: + +``` +curl -o- https://raw.githubusercontent.com/Privado-Inc/privado/main/install.sh | bash +``` + +To uninstall, simply delete `~/.privado/bin`. + +## Install using Go +If you are a GoLang fan, you can use the `go install` command to install the Privado CLI: + +``` +go install github.com/Privado-Inc/privado@latest +``` + +This will place the `privado` binary in your `GOPATH`'s bin directory. This directory must be added to the `$PATH` environment variable. You can learn more [here](https://www.digitalocean.com/community/tutorial_series/how-to-install-and-set-up-a-local-programming-environment-for-go). + +## Install Release Manually +We use [GitHub Releases](https://github.com/Privado-Inc/privado/releases) to ship versioned `privado` releases for supported platforms. You can download a executable of Privado CLI for your platform. + +For example, to setup `privado` for MAC-OSX (arm64), you will download `privado-darwin-amd64.tar.gz`, and run: +``` +tar -xf ~/.privado/privado-darwin-amd64.tar.gz +chmod +x privado +mv privado /usr/bin/privado +``` {% hint style="info" %} diff --git a/docs/privado-cli/scan-results.md b/docs/privado-cli/scan-results.md index 63674820..b5f263e5 100644 --- a/docs/privado-cli/scan-results.md +++ b/docs/privado-cli/scan-results.md @@ -1,6 +1,6 @@ # Scan Results -Once you authenticate, change to the project you want to scan and run command, `privado scan`. +Once you authenticate, run the command, `privado scan `. CLI image @@ -67,5 +67,3 @@ You can remove third parties by marking them as False Positive and give us feedb \ \ - -