litmus-cli 0.2.0 → 0.2.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +50 -0
- package/package.json +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,50 @@
|
|
|
1
|
+
# litmus-cli
|
|
2
|
+
|
|
3
|
+
Official CLI for [Litmus](https://litmus.build) engineering assessments.
|
|
4
|
+
|
|
5
|
+
## Installation
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
npm install -g litmus-cli
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
Requires Node.js 18+.
|
|
12
|
+
|
|
13
|
+
## Usage
|
|
14
|
+
|
|
15
|
+
### Initialize an assessment
|
|
16
|
+
|
|
17
|
+
```bash
|
|
18
|
+
litmus init <token>
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
- Downloads the assessment package
|
|
22
|
+
- Installs dependencies automatically
|
|
23
|
+
- Initializes a git repo with an initial commit
|
|
24
|
+
- Starts background file tracking
|
|
25
|
+
- **Your timer begins when you run this command**
|
|
26
|
+
|
|
27
|
+
Your token is provided on the Litmus candidate portal when you open your assessment.
|
|
28
|
+
|
|
29
|
+
### Submit your work
|
|
30
|
+
|
|
31
|
+
```bash
|
|
32
|
+
litmus submit
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
Run this from inside your assessment folder when you're done. It packages your work (source code + git history + activity log) and uploads it automatically.
|
|
36
|
+
|
|
37
|
+
Use `litmus submit --yes` to skip the confirmation prompt.
|
|
38
|
+
|
|
39
|
+
## How it works
|
|
40
|
+
|
|
41
|
+
1. `litmus init <token>` — sets up your workspace and starts the clock
|
|
42
|
+
2. Work in your preferred editor, committing frequently
|
|
43
|
+
3. `litmus submit` — packages and uploads everything in one step
|
|
44
|
+
|
|
45
|
+
Your git commit history and file activity are included in the submission and used as part of the evaluation. Frequent, meaningful commits are recommended.
|
|
46
|
+
|
|
47
|
+
## Requirements
|
|
48
|
+
|
|
49
|
+
- Node.js 18+
|
|
50
|
+
- Git (recommended — analysis degrades gracefully without it)
|