Metadata-Version: 2.4
Name: sensei-cli
Version: 0.0.1
Summary: Command-line-interface for Sensei Robotics data
Author-email: Sensei Robotics <support@senseirobotics.com>
License-Expression: MIT
Project-URL: Homepage, https://github.com/senseirobotics/sensei-cli
Project-URL: Issues, https://github.com/senseirobotics/sensei-cli/issues
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: OS Independent
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: requests
Requires-Dist: tqdm
Dynamic: license-file

# Sensei CLI

## Installation

1. Activate a conda or virtualenv
2. In this directory, `pip install .`
3. Copy your API key from https://senseirobotics.com/dashboard/settings
4. Run `sensei --key <YOUR KEY>`

## Example Usage

Note: Run `sensei --help` for further info.

### List files

```bash
$ sensei --ls
(DIR) raw
(DIR) test1

2 results

$ sensei --ls raw
(DIR) raw/manual
raw/file1.txt
raw/file2.txt

3 results
```

### Recursively download everything into a directory called `sensei-data`

```bash
sensei --recursive --download /
# or more concise:
sensei -rd
```

### Recursively download everything into a directory called `/PATH/TO/MYDIR`

```bash
sensei --recursive --download / --out /PATH/TO/MYDIR
# or more concise:
sensei -rd / -o /PATH/TO/MYDIR
```

### Download specific file

```bash
sensei --download path/to/my_file.txt
# or more concise:
sensei -d path/to/my_file.txt
```

### Recursively download specific directory

```bash
sensei --recursive --download path/to/my_directory
# or more concise:
sensei -rd path/to/my_directory
```

### Download everything and overwrite existing files

```bash
sensei --recursive --overwrite --download /
# or more concise:
sensei -rwd
```
