README
¶
Sovorem.am CLI
Sovorem.am-ի պաշտոնական command-line գործիքը՝ հայկական backend ծրագրավորման ուսումնական հարթակի համար։ Ուսանողները օգտագործում են էս CLI-ը՝ դասի test-երը լոկալ run անելու և ստորագրված արդյունքները Sovorem.am backend-ին submit անելու համար։
Բովանդակություն
Installation (Տեղադրում)
1. Install Go (Տեղադրել Go-ն)
Sovorem CLI-ից օգտվելու համար քեզ պետք ա համակարգչիդ վրա տեղադրված Golang-ի թարմ version։
Դասընթացների մեծ մասը նախատեսված են Linux-ի կամ macOS-ի համար (կամ Linux-ը Windows-ում՝ WSL-ի միջոցով)։ Եթե Windows ես օգտագործում, սովորաբար ավելի լավ ա ընտրել WSL-ը և հետևել ներքևի Linux-ի հրահանգներին։ Որոշ դասեր նաև Windows/PowerShell-ով են աշխատում։
Տարբերակ 1 (Linux/WSL/macOS). Webi installer-ը ամենապարզ ձևն ա.
curl -sS https://webi.sh/golang | sh
Տարբերակ 2 (ցանկացած ՕՀ, ներառյալ Windows/PowerShell). Օգտվիր Golang-ի պաշտոնական տեղադրման հրահանգներից։
Go-ն տեղադրելուց հետո բացիր նոր terminal-ի պատուհան ու run արա go version՝ համոզվելու համար, որ ամեն ինչ աշխատում ա։
2. Install the Sovorem CLI (Տեղադրել Sovorem CLI-ը)
go install github.com/Sovorem/sovorem@latest
Run արա sovorem --version՝ տեղադրումը ստուգելու համար։
Եթե ստանում ես "command not found" error-ը, ապա ավելացրու Go-ի bin directory-ն քո PATH-ում (սովորաբար $HOME/go/bin-ն ա).
# Linux/WSL
echo 'export PATH=$PATH:$HOME/go/bin' >> ~/.bashrc
source ~/.bashrc
# macOS
echo 'export PATH=$PATH:$HOME/go/bin' >> ~/.zshrc
source ~/.zshrc
# fish
fish_add_path $HOME/go/bin
3. Login to the CLI (Login լինել CLI-ում)
Run արա sovorem login՝ քո Sovorem.am account-ով մուտք գործելու (authenticate լինելու) համար։ Դրանից հետո արդեն պատրաստ ես run ու submit անելու դասերը։
Usage (Օգտագործում)
| Command | Description (Նկարագրություն) |
|---|---|
sovorem login |
Մուտք գործել քո Sovorem.am account-ով (authenticate լինել) |
sovorem logout |
Logout լինել CLI-ից (անջատել account-ը) |
sovorem status |
Ցույց տալ login-ի և version-ի status-ը |
sovorem run UUID |
Run անել դասի test-երը՝ առանց submit անելու |
sovorem run UUID -s |
Run անել test-երը և միանգամից submit անել |
sovorem submit UUID |
Run անել test-երը և արդյունքները submit անել Sovorem.am |
sovorem config base_url URL |
Override անել HTTP test-երի base URL-ը |
sovorem upgrade |
Տեղադրել CLI-ի ամենավերջին version-ը |
Դասի UUID-ները երևում են sovorem.am-ի համապատասխան դասի էջում։
Configuration (Configuration)
CLI-ն պահում ա իր settings-ը ~/.sovorem.yaml ֆայլում, կամ $XDG_CONFIG_HOME/sovorem/config.yaml-ում, եթե XDG_CONFIG_HOME-ը սահմանված ա։
Բոլոր command-երը աջակցում են -h/--help flag-երը։
API base URL (Որ server-ին ա միանում CLI-ը)
Default-ով CLI-ն միանում ա production-ին՝ https://sovorem.am։ Սովորական օգտագործման ժամանակ սա փոխելու կարիք չկա։
Եթե ուզում ես test անել լոկալ dev server-ի կամ staging-ի վրա, օգտագործիր գլոբալ --api-url flag-ը ցանկացած command-ի հետ։ Այն override ա անում թե՛ API-ի, թե՛ login էջի base URL-ը՝ միայն տվյալ command-ի համար (config ֆայլում ոչինչ չի պահվում).
sovorem --api-url http://localhost:3000 login
sovorem --api-url https://stage.sovorem.am run UUID
Մշտական custom endpoint-ի համար (օր․ քո staging-ը) սահմանիր SOVOREM_API_URL (և login էջի համար՝ SOVOREM_FRONTEND_URL) environment variable-ը քո shell-ի profile-ում։
Առաջնահերթությունը (priority)՝ --api-url flag → SOVOREM_API_URL env → default (https://sovorem.am)։
Base URL-ը չի պահվում config ֆայլում — այն binary-ի մեջ ա (default-ը), կամ տրվում ա env/flag-ով։ Այսինքն՝ production-ի endpoint-ը փոխվում ա միայն CLI-ի նոր version-ով (sovorem upgrade), ոչ թե user-ի config ֆայլը խմբագրելով։
Նշում. սա այլ բան ա, քան ներքևի «Base URL HTTP test-երի համար»-ը։ Վերջինս քո սեփական project-ի հասցեն ա HTTP-test դասերի համար, ոչ թե Sovorem-ի server-ը։
Base URL for HTTP tests (Base URL HTTP test-երի համար)
HTTP test-եր ունեցող դասերի համար կարող ես սահմանել base URL, որը կփոխարինի (override կանի) դասի default արժեքին։ Սա պետք ա գալիս, երբ քո լոկալ server-ը աշխատում ա ուրիշ port-ի վրա։
sovorem config base_url http://localhost:8080/
sovorem config base_url
sovorem config base_url --reset
URL-ի մեջ ներառիր նաև protocol scheme-ը (http:// կամ https://)։
CLI colors (CLI-ի գույները)
Կարող ես սահմանել քո նախընտրած գույները terminal-ի output-ի համար (հաջողված, սխալ, լրացուցիչ տեքստ).
sovorem config colors --red VALUE --green VALUE --gray VALUE
sovorem config colors
sovorem config colors --reset
Որպես VALUE օգտագործիր ANSI color code կամ hex տող։
Config-ի խնդիրների լուծում (Troubleshooting)
Configuration-ը ամբողջությամբ reset անելու համար ջնջիր config ֆայլը։ CLI-ն հաջորդ run-ի ժամանակ ավտոմատ կստեղծի նոր ու թարմ ֆայլ։ Դրանից հետո նորից run արա sovorem login։
Upgrading (Update անելը)
CLI-ն ստուգում ա update-ների առկայությունը login լինելիս և մինչև login պահանջող command-եր run անելը։
sovorem upgrade
Կամ կարող ես տեղադրել կոնկրետ version.
go install github.com/Sovorem/sovorem@v0.1.0
Update-ի խնդիրների լուծում (Troubleshooting)
Bypass արա proxy-ն, եթե անընդհատ տեսնում ես նույն upgrade message-ը.
GOPROXY=direct go install github.com/Sovorem/sovorem@latest
Նորից տեղադրիր (Reinstall), եթե դա չօգնեց.
rm "$(which sovorem)"
go install github.com/Sovorem/sovorem@latest
sovorem login
Development (Մշակում)
git clone https://github.com/Sovorem/sovorem.git
cd sovorem
go test ./...
go build -o sovorem .
License (Լիցենզիա)
Տես LICENSE-ը։
Documentation
¶
There is no documentation for this package.
Source Files
Directories