ycli sync¶
Yandex 360 content as files in git.
Usage:
$ ycli sync [OPTIONS] COMMAND [ARGS]...
Options:
--help: Show this message and exit.
Commands:
kinds: List the kinds of object that can be kept...status: Say whatpushwould do with each file,...validate: Check that every file reads as a file of...pull: Read the objects under PATH from the...diff: Show whatpushwould change: each file...push: Send the files that differ from their...
ycli sync kinds¶
List the kinds of object that can be kept as files, and what guards a write of each.
Usage:
$ ycli sync kinds [OPTIONS]
Options:
-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]: Output format (auto = pretty on a TTY, JSON when piped).-y, --yes: Do not ask before an operation that deletes data or grants access.--dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***.--profile NAME: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read.ycli auth profileslists them.-F, --field TEXT: Set any field of the request body: key=value, key[sub]=value for a nested one (JSON-coerced; repeatable). key=@FILE (@- for stdin) gives the file's text as it is; a string that starts with @ goes in JSON quotes ('text="@ivan"'). A flag of the command wins over it. Objects merge; a list replaces the one below it. Give a secret from a file, not typed here: a command line stays in the shell history. Write that file with no line break at its end (printf %s 'secret' > file), or the break goes out with the secret.--body-file FILE: A JSON object (YAML in a .yaml / .yml file) laid under the request body: -F and the command's flags win over it. Objects merge; a list is replaced, not added to. YAML guesses types (no, 1.10): quote a value meant as text.--help: Show this message and exit.
ycli sync status¶
Say what push would do with each file, as far as the files alone say; uses no network.
A file is to update when its content no longer has the fingerprint in its hash key. One
with no hash was written by hand: to create when it names no object, untracked when
it names one. Whether the object changed on the server meanwhile, only diff can say.
Usage:
$ ycli sync status [OPTIONS] [PATHS]...
Arguments:
[PATHS]...: Files or directories to look at; every service's directory by default.
Options:
--kind TEXT: Keep the files of this kind, e.g. wiki/page (repeatable).--show-unchanged: Also list the files that were not edited.--exit-code: Exit with 7 when there is something to push.-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]: Output format (auto = pretty on a TTY, JSON when piped).-y, --yes: Do not ask before an operation that deletes data or grants access.--dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***.--profile NAME: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read.ycli auth profileslists them.-F, --field TEXT: Set any field of the request body: key=value, key[sub]=value for a nested one (JSON-coerced; repeatable). key=@FILE (@- for stdin) gives the file's text as it is; a string that starts with @ goes in JSON quotes ('text="@ivan"'). A flag of the command wins over it. Objects merge; a list replaces the one below it. Give a secret from a file, not typed here: a command line stays in the shell history. Write that file with no line break at its end (printf %s 'secret' > file), or the break goes out with the secret.--body-file FILE: A JSON object (YAML in a .yaml / .yml file) laid under the request body: -F and the command's flags win over it. Objects merge; a list is replaced, not added to. YAML guesses types (no, 1.10): quote a value meant as text.--help: Show this message and exit.
ycli sync validate¶
Check that every file reads as a file of its kind and lies where it should; no network.
Prints the files that do not, each with its line and the reason, and exits non-zero if there is one. Fit for a pre-commit hook.
Usage:
$ ycli sync validate [OPTIONS] [PATHS]...
Arguments:
[PATHS]...: Files or directories to look at; every service's directory by default.
Options:
--kind TEXT: Keep the files of this kind, e.g. wiki/page (repeatable).-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]: Output format (auto = pretty on a TTY, JSON when piped).-y, --yes: Do not ask before an operation that deletes data or grants access.--dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***.--profile NAME: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read.ycli auth profileslists them.-F, --field TEXT: Set any field of the request body: key=value, key[sub]=value for a nested one (JSON-coerced; repeatable). key=@FILE (@- for stdin) gives the file's text as it is; a string that starts with @ goes in JSON quotes ('text="@ivan"'). A flag of the command wins over it. Objects merge; a list replaces the one below it. Give a secret from a file, not typed here: a command line stays in the shell history. Write that file with no line break at its end (printf %s 'secret' > file), or the break goes out with the secret.--body-file FILE: A JSON object (YAML in a .yaml / .yml file) laid under the request body: -F and the command's flags win over it. Objects merge; a list is replaced, not added to. YAML guesses types (no, 1.10): quote a value meant as text.--help: Show this message and exit.
ycli sync pull¶
Read the objects under PATH from the server and write each as its file.
A file is written over whatever is there: commit your edits first, git is what protects them. With --dry-run nothing is written, and a file that holds uncommitted work is named. An object no kind keeps (a grid among Wiki pages) is listed as skipped.
Usage:
$ ycli sync pull [OPTIONS] PATH
Arguments:
PATH: What to pull: wiki/with the pages under it, tracker/queues/ . [required]
Options:
--kind TEXT: Keep the files of this kind, e.g. wiki/page (repeatable).--show-unchanged: Also list the files that were the same.-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]: Output format (auto = pretty on a TTY, JSON when piped).-y, --yes: Do not ask before an operation that deletes data or grants access.--dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***.--profile NAME: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read.ycli auth profileslists them.-F, --field TEXT: Set any field of the request body: key=value, key[sub]=value for a nested one (JSON-coerced; repeatable). key=@FILE (@- for stdin) gives the file's text as it is; a string that starts with @ goes in JSON quotes ('text="@ivan"'). A flag of the command wins over it. Objects merge; a list replaces the one below it. Give a secret from a file, not typed here: a command line stays in the shell history. Write that file with no line break at its end (printf %s 'secret' > file), or the break goes out with the secret.--body-file FILE: A JSON object (YAML in a .yaml / .yml file) laid under the request body: -F and the command's flags win over it. Objects merge; a list is replaced, not added to. YAML guesses types (no, 1.10): quote a value meant as text.--help: Show this message and exit.
ycli sync diff¶
Show what push would change: each file against its object on the server, as it is now.
The difference runs from the server to the file. Under a directory that names a container (wiki/team, tracker/queues/DE) an object with no file is listed too. Where the object changed since the file was read, the difference is the file against the server now: the file keeps no copy of what was read, so whose change a line is cannot be said.
Usage:
$ ycli sync diff [OPTIONS] [PATHS]...
Arguments:
[PATHS]...: Files or directories to look at; every service's directory by default.
Options:
--kind TEXT: Keep the files of this kind, e.g. wiki/page (repeatable).--show-unchanged: Also list the files with nothing to push.--show-secrets: Show secrets as they are, not masked.--exit-code: Exit with 7 when there is something to push, 8 when a file and its object went apart.-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]: Output format (auto = pretty on a TTY, JSON when piped).-y, --yes: Do not ask before an operation that deletes data or grants access.--dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***.--profile NAME: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read.ycli auth profileslists them.-F, --field TEXT: Set any field of the request body: key=value, key[sub]=value for a nested one (JSON-coerced; repeatable). key=@FILE (@- for stdin) gives the file's text as it is; a string that starts with @ goes in JSON quotes ('text="@ivan"'). A flag of the command wins over it. Objects merge; a list replaces the one below it. Give a secret from a file, not typed here: a command line stays in the shell history. Write that file with no line break at its end (printf %s 'secret' > file), or the break goes out with the secret.--body-file FILE: A JSON object (YAML in a .yaml / .yml file) laid under the request body: -F and the command's flags win over it. Objects merge; a list is replaced, not added to. YAML guesses types (no, 1.10): quote a value meant as text.--help: Show this message and exit.
ycli sync push¶
Send the files that differ from their objects, each write read back and compared.
A file is sent only when its object is as the file was read: one whose object changed on
the server, is gone, or was never read is stopped (exit 8) until a pull. After a write
the object is read again: the file gets its new link, and a value the server did not keep
fails the file and is named. A new file gets the identity of what was created. With
--dry-run nothing is sent and the plan is printed; diff shows it with the differences.
Usage:
$ ycli sync push [OPTIONS] [PATHS]...
Arguments:
[PATHS]...: Files or directories to look at; every service's directory by default.
Options:
--kind TEXT: Keep the files of this kind, e.g. wiki/page (repeatable).--show-unchanged: Also list the files with nothing to push.--prune COMMIT: Also delete the objects whose files were deleted since this commit.--on-error [fail|abort]: After a file fails: go on to the next, or end the run. [default: fail]-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]: Output format (auto = pretty on a TTY, JSON when piped).-y, --yes: Do not ask before an operation that deletes data or grants access.--dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***.--profile NAME: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read.ycli auth profileslists them.-F, --field TEXT: Set any field of the request body: key=value, key[sub]=value for a nested one (JSON-coerced; repeatable). key=@FILE (@- for stdin) gives the file's text as it is; a string that starts with @ goes in JSON quotes ('text="@ivan"'). A flag of the command wins over it. Objects merge; a list replaces the one below it. Give a secret from a file, not typed here: a command line stays in the shell history. Write that file with no line break at its end (printf %s 'secret' > file), or the break goes out with the secret.--body-file FILE: A JSON object (YAML in a .yaml / .yml file) laid under the request body: -F and the command's flags win over it. Objects merge; a list is replaced, not added to. YAML guesses types (no, 1.10): quote a value meant as text.--help: Show this message and exit.