# CLI equivalent for UI status

**URL:** <https://kopia.discourse.group/t/cli-equivalent-for-ui-status/3227>\
**Category:** General Topics\
**Created:** [August 28, 2024, 7:46pm UTC](https://kopia.discourse.group/t/cli-equivalent-for-ui-status/3227 "2024-08-28T19:46:26Z")\
**Posts on this page:** 9\
**Page:** 1

<div class="post-metadata">

**Author:** ![bakedbeans](https://avatars.discourse-cdn.com/v4/letter/b/e68b1a/32.png) [@bakedbeans](https://kopia.discourse.group/u/bakedbeans)\
**Post date:** [August 28, 2024, 7:46pm UTC](https://kopia.discourse.group/t/cli-equivalent-for-ui-status/3227/1 "2024-08-28T19:46:26Z")

</div>

I enjoy using the UI to view the details and progress of my snapshot, as well as viewing the active tasks. I can’t seem to find anywhere where I can parse that through a cli command. Ideas?

---

<div class="post-metadata">

**Author:** ![larryc](https://yyz2.discourse-cdn.com/free1/user_avatar/kopia.discourse.group/larryc/32/1172_2.png) [@larryc](https://kopia.discourse.group/u/larryc)\
**Post date:** [August 29, 2024, 10:13pm UTC](https://kopia.discourse.group/t/cli-equivalent-for-ui-status/3227/2 "2024-08-29T22:13:55Z")

</div>

Seems like that was also asked a while ago without an answer: [Snapshot status - Support - Kopia Forum](https://kopia.discourse.group/t/snapshot-status/1897)

---

<div class="post-metadata">

**Author:** ![iBackup](https://yyz2.discourse-cdn.com/free1/user_avatar/kopia.discourse.group/ibackup/32/355_2.png) [@iBackup](https://kopia.discourse.group/u/iBackup)\
**Post date:** [August 30, 2024, 8:09pm UTC](https://kopia.discourse.group/t/cli-equivalent-for-ui-status/3227/3 "2024-08-30T20:09:46Z")

</div>

```auto
kopia snapshot create --no-progress /path/to/subject4backup

```

It will return something short, like

```auto
Connected to repository.
Snapshotting root@mx724:/ ...
Created snapshot with root kXXX and ID xxx in 1h39m32s
Running quick maintenance...
Finished quick maintenance.

```

on success, or it will include errors, like

```auto
Connected to repository.
Snapshotting root@mx724l:/ ...
Error when processing "usr/local/virtual/example.com/user/folder/new/file": no such file or directory
Created snapshot with root kXXX and ID dXXX in 1h15m54s
Running quick maintenance...
Finished quick maintenance.
e[31mERRORe[0m Found 1 fatal error(s) while snapshotting root@mx724:/.

```

So the gist is undocumented option `--no-progress` which trim kopia’s output to parsable status text only

---

<div class="post-metadata">

**Author:** ![larryc](https://yyz2.discourse-cdn.com/free1/user_avatar/kopia.discourse.group/larryc/32/1172_2.png) [@larryc](https://kopia.discourse.group/u/larryc)\
**Post date:** [August 31, 2024, 6:54pm UTC](https://kopia.discourse.group/t/cli-equivalent-for-ui-status/3227/4 "2024-08-31T18:54:53Z")

</div>

> [@iBackup](#):
>
> So the gist is undocumented option `--no-progress` which trim kopia’s output to parsable status text only

Thank you. Out of curiosity, how did you find out about the undocumented option?

---

<div class="post-metadata">

**Author:** ![iBackup](https://yyz2.discourse-cdn.com/free1/user_avatar/kopia.discourse.group/ibackup/32/355_2.png) [@iBackup](https://kopia.discourse.group/u/iBackup)\
**Post date:** [September 1, 2024, 10:37am UTC](https://kopia.discourse.group/t/cli-equivalent-for-ui-status/3227/5 "2024-09-01T10:37:47Z")

</div>

> [@larryc](#):
>
> Out of curiosity, how did you find out about the undocumented option?

I looked for the solution to reduce amount of useless and huge unparsable email reports to be able to automate alarms on failed backup, searched in source code and google till finally found it.  
I called this option as undocumented because it [absent in the git repository](https://kopia.io/docs/reference/command-line/flags/), but it [listed online](https://kopia.io/docs/reference/command-line/flags/) and present in actual `kopia`’s code.

---

<div class="post-metadata">

**Author:** ![larryc](https://yyz2.discourse-cdn.com/free1/user_avatar/kopia.discourse.group/larryc/32/1172_2.png) [@larryc](https://kopia.discourse.group/u/larryc)\
**Post date:** [September 1, 2024, 10:40pm UTC](https://kopia.discourse.group/t/cli-equivalent-for-ui-status/3227/6 "2024-09-01T22:40:14Z")

</div>

You raise a good point… I’d say this flag is not “undocumented”; rather, it’s “poorly documented.” It is indeed listed in the online site as you pointed out, but it does not show up if you run `kopia --help` (which is expected I suppose), but it also does not show up if you run `kopia --help-full`.

There’s a related github issue [here](https://github.com/kopia/kopia/issues/2680), which I’ve posted a comment on. Unfortunately the issue has been open since January 2023, so doesn’t appear to have much traction.

---

<div class="post-metadata">

**Author:** ![bakedbeans](https://avatars.discourse-cdn.com/v4/letter/b/e68b1a/32.png) [@bakedbeans](https://kopia.discourse.group/u/bakedbeans)\
**Post date:** [September 3, 2024, 12:57pm UTC](https://kopia.discourse.group/t/cli-equivalent-for-ui-status/3227/7 "2024-09-03T12:57:52Z")

</div>

Could I pipe this to a text file using linux and execute the command in the background? that way I can track running backups and avoid keeping cli open the whole time. Particularly checking in on long-running commands

---

<div class="post-metadata">

**Author:** ![iBackup](https://yyz2.discourse-cdn.com/free1/user_avatar/kopia.discourse.group/ibackup/32/355_2.png) [@iBackup](https://kopia.discourse.group/u/iBackup)\
**Post date:** [September 9, 2024, 1:21pm UTC](https://kopia.discourse.group/t/cli-equivalent-for-ui-status/3227/8 "2024-09-09T13:21:03Z")

</div>

> [@larryc](#):
>
> You raise a good point… I’d say this flag is not “undocumented”; rather, it’s “poorly documented.”

If part of documentation is absent (for some very unknown reason, it blocked in `.gitignore`) from official `kopia's` repository as well from official `--help`, `--help-full`, `--help-long` then it mean **undocumented**. Also I have no clue why this `--no-progress` option is marked as **[ADV]** that supposed to be use only by advanced users

---

<div class="post-metadata">

**Author:** ![iBackup](https://yyz2.discourse-cdn.com/free1/user_avatar/kopia.discourse.group/ibackup/32/355_2.png) [@iBackup](https://kopia.discourse.group/u/iBackup)\
**Post date:** [September 9, 2024, 1:23pm UTC](https://kopia.discourse.group/t/cli-equivalent-for-ui-status/3227/9 "2024-09-09T13:23:44Z")

</div>

> Could I pipe this to a text file using linux and execute the command in the background?

Yes, sure. Use either `nohup kopia...options... >/path/to/log 2>&1` or use some terminal multiplexers, like `screen` or `tmux` when you run `kopia...options... >/path/to/log 2>&1`
