-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #7 from DSGT-DLP/update-readme
update readme
- Loading branch information
Showing
1 changed file
with
20 additions
and
7 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,25 +1,38 @@ | ||
| # dlp-cli installation | ||
|
|
||
| ## Unix installation (Linux, MacOS) | ||
| ## Unix installation (Linux, MacOS, WSL) | ||
|
|
||
| Step 1: Install homebrew (homebrew only works on mac and linux, so windows users may need WSL, may look into supporting winget in the future). You can find installation instructions for homebrew at [https://brew.sh/](https://brew.sh/) | ||
| Step 0: If on Windows, install [WSL](https://learn.microsoft.com/en-us/windows/wsl/install) | ||
|
|
||
| Step 1: Install homebrew. You can find installation instructions for homebrew at [https://brew.sh/](https://brew.sh/) | ||
|
|
||
| Step 2: Run `brew tap DSGT-DLP/dlp-cli` in the terminal | ||
|
|
||
| Step 3: Run `brew install dlp-cli` in the terminal | ||
|
|
||
| ## Windows installation | ||
| **NOTE (WSL):** You may need to append the `-w` flag to every cli command to tell dlp-cli to run bash cmds without pseudoterminals, which as of now only work in Unix environments. | ||
|
|
||
| ## Windows installation (Do this if WSL doesn't work) | ||
|
|
||
| Step 1: If you don't have the `dlp-cli` submodule, run `git submodule init dlp-cli` in the project directory. Then run `git submodule update`. If it says that you are in a detached HEAD state, cd to the dlp-cli submodule directory and `git checkout main`. | ||
|
|
||
| Step 1: If you don't have the `dlp-cli` submodule, run `git submodule init dlp-cli` in the project directory. Then run `git submodule update`. | ||
| Step 2: Run `winget settings --enable LocalManifestFiles` as administrator. Then, in the project directory, run `winget install -m dlp-cli/manifests/d/DSGT-DLP/dlp-cli/{version}`. Replace `{version}` with the version number that you want (typically the latest version). | ||
|
|
||
| Step 2: In the project directory, run `winget install -m dlp-cli/manifests/d/DSGT-DLP/dlp-cli/{version}`. Replace `{version}` with the version number that you want (typically the latest version). | ||
| Step 3: Add the path to the install location to your PATH environment variable (somewhere within `%localappdata%\microsoft\winget\packages`, may need file explorer to find the exact folder) | ||
|
|
||
| ## Usage | ||
|
|
||
| Run `dlp-cli` in DLP's project directory in the terminal | ||
|
|
||
| ## Cli Development Info | ||
| ## CLI Development Info | ||
|
|
||
| Run cli in debug mode with `go run main.go` | ||
| Run the cli in debug mode with `go run main.go` | ||
|
|
||
| Make sure to add package paths of all files as imports in main.go | ||
|
|
||
| ## FAQs | ||
|
|
||
| ### panic: input/output error | ||
|
|
||
|  | ||
| If you are on WSL, append the `-w` flag to tell the dlp-cli to run bash cmds without pseudoterminals, which are handled differently on windows and WSL. The way that the dlp-cli uses pseudoterminals currently only work in unix environments. |