Skip to content

Commit

Permalink
initial commit
Browse files Browse the repository at this point in the history
  • Loading branch information
this-oliver committed Jan 16, 2025
0 parents commit e3798a9
Show file tree
Hide file tree
Showing 3 changed files with 54 additions and 0 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
.venv
51 changes: 51 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
# Solokey Config

Shortcuts:

- [solo1 cli](https://pypi.org/project/solo1/) (you'll need [fido2](https://pypi.org/project/fido2/0.9.3/) for setting a key pin)
- [solo2 cli](https://github.com/solokeys/solo2-cli)

## Getting Started

Depending on the cli you're using, you'll need to install the appropriate package.

### Solo1

Pre-requisites:

- [install python3](https://www.python.org/downloads/)

```bash
python3 -m pip install -r requirements.txt
```

### Solo2

Pre-requisites:

- [install rust](https://www.rust-lang.org/tools/install)

```bash
cargo install solo2
```

## Usage

This section will cover the basic usage of the solokey cli for both solo1 and solo2.

Updating your key:

```bash
# Solo1 cli
solo1 key update

# Solo2 cli
solo2 update
```

Setting a key pin (*solo1 cli also works for solo2*):

```bash
# Solo1 cli
solo1 key set-pin
```
2 changes: 2 additions & 0 deletions requirements.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
fido2==0.9.3
solo1==0.1.1

0 comments on commit e3798a9

Please sign in to comment.