diff options
| author | Daniil Baturin <daniil@baturin.org> | 2024-05-22 13:57:11 +0100 |
|---|---|---|
| committer | Daniil Baturin <daniil@baturin.org> | 2024-05-22 14:10:02 +0100 |
| commit | fdcbb845ddc5cc646cfa01f590b0ea331c31f80b (patch) | |
| tree | eaffae0dffcc951b60c35cc3329051e40021a9ee | |
| parent | a89b0e79b00aa656cede3c6527cfda23b5ea19b1 (diff) | |
| download | vyos-utils-fdcbb845ddc5cc646cfa01f590b0ea331c31f80b.tar.gz vyos-utils-fdcbb845ddc5cc646cfa01f590b0ea331c31f80b.zip | |
T6380: Add an actual README
| -rw-r--r-- | README.md | 15 |
1 files changed, 14 insertions, 1 deletions
@@ -1 +1,14 @@ -# vyos-utils
\ No newline at end of file +# vyos-utils + +This repository contains utility binaries used by the VyOS CLI, +written in OCaml for speed and memory safety. + +Currently, they are: + +* `validate_value` — the top-level validation utility that checks regexes and executes external validators. +* `validators` — validator executables: + * `file_path` — checks directory and file paths. + * `numeric` — checks numbers and number ranges. + * `url` — checks URLs/URIs. +* `completion` — completion helpers: + * `list_interfaces` — produces lists of network interfaces. |