@softpractice/softpractice-cli 0.1.3 → 0.1.5

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.
Files changed (2) hide show
  1. package/README.md +26 -4
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -6,6 +6,8 @@
6
6
 
7
7
  # SoftPractice CLI
8
8
 
9
+ English | [Русский](https://github.com/arthur-s/softpractice-cli/blob/main/README_RU.md)
10
+
9
11
  The command-line companion for [SoftPractice](https://softpractice.ru) — an
10
12
  online platform for project-based programming practice with an AI mentor.
11
13
 
@@ -14,10 +16,6 @@ projects, submit committed solutions for review, receive feedback, and continue
14
16
  through a practicum lesson by lesson. The CLI connects your local development
15
17
  workflow to your SoftPractice workspace.
16
18
 
17
- > SoftPractice — онлайн-тренажёр по программированию с AI-наставником,
18
- > построенный вокруг практической работы над проектами. CLI позволяет получать
19
- > задания, отправлять решения и переходить между уроками прямо из терминала.
20
-
21
19
  ## Install
22
20
 
23
21
  ```bash
@@ -78,6 +76,7 @@ softpractice update
78
76
  | `softpractice login` | Sign in through the browser |
79
77
  | `softpractice starter` | Download the first lesson project |
80
78
  | `softpractice status` | Show the current lesson and local project state |
79
+ | `softpractice check` | Run public checks against the current working tree |
81
80
  | `softpractice submit` | Submit the current committed Git revision |
82
81
  | `softpractice submission show` | Show the latest submission and review result |
83
82
  | `softpractice update` | Apply the transition to the next lesson |
@@ -86,6 +85,29 @@ softpractice update
86
85
 
87
86
  Run `softpractice help <command>` for detailed help.
88
87
 
88
+ ## Local checks
89
+
90
+ Run the public checks while working, including against uncommitted changes:
91
+
92
+ ```bash
93
+ softpractice check
94
+ ```
95
+
96
+ The command uses the current working tree and does not submit anything. If the
97
+ project uses a Python virtual environment, activate it first so the configured
98
+ `python3` command resolves to that environment.
99
+
100
+ To run the checks automatically against the exact committed revision before
101
+ each submission:
102
+
103
+ ```bash
104
+ softpractice set auto-checks true
105
+ ```
106
+
107
+ `softpractice submit --checks` enables the same pre-submission check for one
108
+ run. Unlike `softpractice check`, submission checks require a clean working
109
+ tree and run in an isolated snapshot of `HEAD`.
110
+
89
111
  ## Language
90
112
 
91
113
  SoftPractice CLI supports English and Russian and selects a language from the
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@softpractice/softpractice-cli",
3
- "version": "0.1.3",
3
+ "version": "0.1.5",
4
4
  "description": "CLI for SoftPractice, an online platform for project-based programming practice",
5
5
  "license": "MIT",
6
6
  "author": "Arthur Sultanbekov",