vielle.dev
+43
-4
README.md
+43
-4
README.md
···
8
8
9
9
## Installation
10
10
11
-
// TODO
11
+
Prerequisites:
12
+
13
+
- `Git`
14
+
- `Rust` (1.88+)
15
+
- `Cargo`
16
+
17
+
1. Clone this repo:
18
+
`git clone git@tangled.sh:vielle.dev/tangled-on-commit`
19
+
2. Compile the binary:
20
+
`cargo build --release`
21
+
3. Copy the binary to your path:
22
+
`sudo cp ./target/release/tangled-on-commit /bin`
12
23
13
24
## Usage
14
25
15
-
// TODO
26
+
### CLI Arguments
27
+
28
+
- `tangled-on-commit (-h | --help)`
29
+
Displays this message
30
+
31
+
- `tangled-on-commit`
32
+
No specified handle, repo, or command. Falls back to config/env
33
+
34
+
- `tangled-on-commit SHELL`
35
+
Uses config/env for handle and repo
36
+
37
+
- `tangled-on-commit @HANDLE SHELL`
38
+
Uses config/env for repo
39
+
40
+
- `tangled-on-commit REPO SHELL`
41
+
Uses config/env for handle
42
+
43
+
- `tangled-on-commit @HANDLE/REPO SHELL`
44
+
`tangled-on-commit HANDLE REPO SHELL`
45
+
No config/env
46
+
47
+
### JSON
48
+
49
+
Loads the file `tangled-on-commit.json` from cwd if it exists.
50
+
Reads keys \"handle\", \"repo_name\", and \"shell\".
51
+
Unknown keys are ignored and any key can be ommitted
52
+
JSON is used if the arguments aren't passed to the CLI
16
53
17
-
## Configuration
54
+
### Env
18
55
19
-
// TODO
56
+
Loads the environment variables `TANGLED_ON_COMMIT_HANDLE` and `TANGLED_ON_COMMIT_REPO_NAME`
57
+
Shell cannot be set by environment variables.
58
+
Env variables are used if relevant keys are ommitted an arguments aren't passed to the CLI.