Add initial scripts and project conventions
This commit is contained in:
1 parent
af9f32facc
commit
c777cf115b
14 files changed
+982
-9
No files matched your search
@@ -0,0 +1,50 @@
|
||||
# StrixScripts
|
||||
|
||||
Колекция от самостоятелни bash скриптове, организирани по функционални
|
||||
папки. Всеки скрипт има собствена `.md` документация до себе си с пълно
|
||||
описание, изисквания и примери.
|
||||
|
||||
За AI агенти, работещи в repo-то: виж [`AGENTS.md`](./AGENTS.md) за
|
||||
задължителните конвенции при създаване на нов скрипт — структура,
|
||||
`--help` поведение, shellcheck, документация.
|
||||
|
||||
## Структура
|
||||
|
||||
```
|
||||
strixscripts/
|
||||
├── lib/
|
||||
│ └── common.sh споделени helper функции (--help, error handling, logging)
|
||||
├── templates/ шаблони за нов скрипт + неговия .md файл
|
||||
├── examples/
|
||||
│ └── hello-world.sh работещ пример, демонстриращ пълната конвенция
|
||||
├── HDD/
|
||||
│ ├── repair-hdd.sh презапис на диск и SMART extended self-test
|
||||
│ └── erase-storage.sh презапис на дял или Secure Erase/Sanitize на диск
|
||||
└── <категория>/ функционална група скриптове (предстои)
|
||||
```
|
||||
|
||||
## Как се използва скрипт
|
||||
|
||||
Всеки скрипт поддържа `--help`:
|
||||
|
||||
```bash
|
||||
./<категория>/<script-name>.sh --help
|
||||
```
|
||||
|
||||
## Категории
|
||||
|
||||
<!-- Всяка нова категория папка получава своя секция тук, с кратко
|
||||
описание на всеки скрипт в нея + link към пълната документация.
|
||||
Пълното описание живее в скрипт-специфичния .md, не тук. -->
|
||||
|
||||
### examples/ (референция, не production скриптове)
|
||||
|
||||
- [`hello-world.sh`](./examples/hello-world.md) — демонстрационен скрипт,
|
||||
показващ конвенцията за нов скрипт в repo-то.
|
||||
|
||||
### HDD/
|
||||
|
||||
- [`repair-hdd.sh`](./HDD/repair-hdd.md) — презаписва избран диск и
|
||||
изпълнява SMART extended self-test.
|
||||
- [`erase-storage.sh`](./HDD/erase-storage.md) — презаписва дял с един проход
|
||||
или използва поддържан Secure Erase/Sanitize за цял диск.
|
||||
Reference in new issue
Block a user