Skip to content

Commit

Permalink
Add info about -w cmd
Browse files Browse the repository at this point in the history
  • Loading branch information
dwu359 authored Sep 27, 2023
1 parent 2ed81dc commit 1333fe6
Showing 1 changed file with 11 additions and 2 deletions.
13 changes: 11 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@ Step 2: Run `brew tap DSGT-DLP/dlp-cli` in the terminal

Step 3: Run `brew install dlp-cli` in the terminal

**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`.
Expand All @@ -22,8 +24,15 @@ Step 3: Add the path to the install location to your PATH environment variable (

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

![input-output-error](https://github.com/DSGT-DLP/dlp-cli/assets/54150946/b9acfcca-4646-4086-9aea-e4f262520d87)
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.

0 comments on commit 1333fe6

Please sign in to comment.