larryh/corso
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Consistently assume that Corso was downloaded and is not on the path (#1275)

Browse Source 
## Description

- Don't make assumptions about corso being on the path
- Assume that corso is in the CWD
- We also don't need the `.exe` suffix on Windows

## Type of change

- [x] 🗺️ Documentation
This commit is contained in:
Niraj Tolia 2022-10-21 00:38:01 -07:00 committed by GitHub
parent 078a47726b
commit 9dc53bd9f8
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 14 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
docs/docs/quickstart.md
View File

@ -61,7 +61,7 @@ Corso binary or container.
```powershell ```powershell
# Initialize the Corso Repository # Initialize the Corso Repository
$Env:CORSO_PASSPHRASE = "CHANGE-ME-THIS-IS-INSECURE" $Env:CORSO_PASSPHRASE = "CHANGE-ME-THIS-IS-INSECURE"
.\corso.exe repo init s3 --bucket corso-test .\corso repo init s3 --bucket corso-test
``` ```
</TabItem> </TabItem>
@ -70,7 +70,7 @@ Corso binary or container.
```bash ```bash
# Initialize the Corso Repository # Initialize the Corso Repository
export CORSO_PASSPHRASE="CHANGE-ME-THIS-IS-INSECURE" export CORSO_PASSPHRASE="CHANGE-ME-THIS-IS-INSECURE"
corso repo init s3 --bucket corso-test ./corso repo init s3 --bucket corso-test
``` ```
</TabItem> </TabItem>
@ -109,7 +109,7 @@ you initialized the Corso repository, you might need to [connect to it again](/s
```powershell ```powershell
# Backup your inbox # Backup your inbox
.\corso.exe backup create exchange --user <your exchange email address> .\corso backup create exchange --user <your exchange email address>
``` ```
</TabItem> </TabItem>
@ -117,7 +117,7 @@ you initialized the Corso repository, you might need to [connect to it again](/s
```bash ```bash
# Backup your inbox # Backup your inbox
corso backup create exchange --user <your exchange email address> ./corso backup create exchange --user <your exchange email address>
``` ```
</TabItem> </TabItem>
@ -155,7 +155,7 @@ You can see all Exchange backups available with the following command:
```powershell ```powershell
# List all Exchange backups # List all Exchange backups
.\corso.exe backup list exchange .\corso backup list exchange
``` ```
</TabItem> </TabItem>
@ -163,7 +163,7 @@ You can see all Exchange backups available with the following command:
```bash ```bash
# List all Exchange backups # List all Exchange backups
corso backup list exchange ./corso backup list exchange
``` ```
</TabItem> </TabItem>
@ -193,7 +193,7 @@ Next, select one of the available backups and list all backed up emails. See
```powershell ```powershell
# List emails in a selected backup # List emails in a selected backup
.\corso.exe backup details exchange --backup <id of your selected backup> --email "*" | Select-Object -First 5 .\corso backup details exchange --backup <id of your selected backup> --email "*" | Select-Object -First 5
``` ```
</TabItem> </TabItem>
@ -201,7 +201,7 @@ Next, select one of the available backups and list all backed up emails. See
```bash ```bash
# List emails in a selected backup # List emails in a selected backup
corso backup details exchange --backup <id of your selected backup> --email "*" | head ./corso backup details exchange --backup <id of your selected backup> --email "*" | head
``` ```
</TabItem> </TabItem>
@ -234,7 +234,7 @@ When you are ready to restore the selected email, use the following command.
```powershell ```powershell
# Restore a selected email # Restore a selected email
.\corso.exe restore exchange --backup <id of your selected backup> --email <email reference> .\corso restore exchange --backup <id of your selected backup> --email <email reference>
``` ```
</TabItem> </TabItem>
@ -242,7 +242,7 @@ When you are ready to restore the selected email, use the following command.
```bash ```bash
# Restore a selected email # Restore a selected email
corso restore exchange --backup <id of your selected backup> --email <email reference> ./corso restore exchange --backup <id of your selected backup> --email <email reference>
``` ```
</TabItem> </TabItem>

8
docs/docs/setup/repos.md
View File

@ -74,7 +74,7 @@ Before first use, you need to initialize a Corso repository with `corso repo ini
```powershell ```powershell
# Initialize the Corso Repository # Initialize the Corso Repository
$Env:CORSO_PASSPHRASE = "CHANGE-ME-THIS-IS-INSECURE" $Env:CORSO_PASSPHRASE = "CHANGE-ME-THIS-IS-INSECURE"
.\corso.exe repo init s3 --bucket corso-test .\corso repo init s3 --bucket corso-test
``` ```
</TabItem> </TabItem>
@ -83,7 +83,7 @@ Before first use, you need to initialize a Corso repository with `corso repo ini
```bash ```bash
# Initialize the Corso Repository # Initialize the Corso Repository
export CORSO_PASSPHRASE="CHANGE-ME-THIS-IS-INSECURE" export CORSO_PASSPHRASE="CHANGE-ME-THIS-IS-INSECURE"
corso repo init s3 --bucket corso-test ./corso repo init s3 --bucket corso-test
``` ```
</TabItem> </TabItem>
@ -110,7 +110,7 @@ If a repository already exists, you can connect to it with `corso repo connect s
```powershell ```powershell
# Connect to the Corso Repository # Connect to the Corso Repository
.\corso.exe repo connect s3 --bucket corso-test .\corso repo connect s3 --bucket corso-test
``` ```
</TabItem> </TabItem>
@ -118,7 +118,7 @@ If a repository already exists, you can connect to it with `corso repo connect s
```bash ```bash
# Connect to the Corso Repository # Connect to the Corso Repository
corso repo connect s3 --bucket corso-test ./corso repo connect s3 --bucket corso-test
``` ```
</TabItem> </TabItem>