@softpractice/softpractice-cli
v0.1.5
Published
CLI for SoftPractice, an online platform for project-based programming practice
Downloads
890
Readme
SoftPractice CLI
English | Русский
The command-line companion for SoftPractice — an online platform for project-based programming practice with an AI mentor.
SoftPractice lets you work on realistic programming tasks in local Git projects, submit committed solutions for review, receive feedback, and continue through a practicum lesson by lesson. The CLI connects your local development workflow to your SoftPractice workspace.
Install
npm install -g @softpractice/softpractice-cliVerify the installation:
softpractice --helpGetting started
Sign in to SoftPractice:
softpractice loginDownload the starter project for your current practicum:
softpractice starterOpen the created directory and check the current lesson:
cd <project-directory>
softpractice statusWork on the project and commit your changes with Git. When the solution is ready, submit the current commit:
softpractice submitCheck the submission and open its result:
softpractice submission show
softpractice openAfter an accepted solution, apply the transition to the next available lesson:
softpractice updateCommon commands
| Command | Description |
| --- | --- |
| softpractice login | Sign in through the browser |
| softpractice starter | Download the first lesson project |
| softpractice status | Show the current lesson and local project state |
| softpractice check | Run public checks against the current working tree |
| softpractice submit | Submit the current committed Git revision |
| softpractice submission show | Show the latest submission and review result |
| softpractice update | Apply the transition to the next lesson |
| softpractice open | Open the workspace or latest result in the browser |
| softpractice project restore | Restore a project from the latest usable revision |
Run softpractice help <command> for detailed help.
Local checks
Run the public checks while working, including against uncommitted changes:
softpractice checkThe command uses the current working tree and does not submit anything. If the
project uses a Python virtual environment, activate it first so the configured
python3 command resolves to that environment.
To run the checks automatically against the exact committed revision before each submission:
softpractice set auto-checks truesoftpractice submit --checks enables the same pre-submission check for one
run. Unlike softpractice check, submission checks require a clean working
tree and run in an isolated snapshot of HEAD.
Language
SoftPractice CLI supports English and Russian and selects a language from the system locale when possible.
Choose a language explicitly:
softpractice set lang en
softpractice set lang ruYou can also override it for a single command:
softpractice --lang ru statusProject recovery
If the original project directory is unavailable, restore the latest usable revision into a new directory:
softpractice project restore \
--practicum <practicum-id> \
--directory ./restored-projectThe CLI never overwrites an existing project directory.
