Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/neved4/tmbackup
Seamless Time Machine backups!
https://github.com/neved4/tmbackup
backup big-sur cli command line macos monterey script sonoma terminal time-machine tool ventura
Last synced: 3 months ago
JSON representation
Seamless Time Machine backups!
- Host: GitHub
- URL: https://github.com/neved4/tmbackup
- Owner: Neved4
- License: mit
- Created: 2023-10-31T21:31:24.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-07-09T11:09:26.000Z (7 months ago)
- Last Synced: 2024-11-02T13:51:53.332Z (3 months ago)
- Topics: backup, big-sur, cli, command, line, macos, monterey, script, sonoma, terminal, time-machine, tool, ventura
- Language: Awk
- Homepage:
- Size: 312 KB
- Stars: 5
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
## `tmbackup` - Seamless Time Machine backups! 🚀
Fast, light [macOS] utility that performs [Time Machine] backups on all
connected drives.
###### Generated using [`agg`], [`asciinema`], `Menlo` typeface, theme `Github Dark`.
### Highlights
- 🚀 _**Fast**_ - minimal overhead, [tmbackup.awk](src/tmbackup.awk)
executes in only ~ `15 ms`.[^1]
- 🎨 _**Intuitive**_ - user-friendly, clear color-coded
messages for every backup status.
- 🔒 _**Robust**_ - ensures reliability with effective error handling
during the backup.
- 📦 _**Self-contained**_ - no dependencies, lightweight, uses POSIX `awk`,
`sh` (e.g. `3629 bytes`, `186 lines`).
## Getting Started
> [!NOTE]
> _This utility is only intended to work in macOS._
### Installation
If you have [`brew`] installed, just run:
```sh
$ brew install Neved4/tap/tmbackup
```
### Usage
```sh
$ ./tmbackup.sh
```
#### Logging
```sh
tmbackup | tee -a /path/to/output.log
```
### Compatibility
#### Supported macOS Versions
| Version | Supported |
| :---------------------- | :-------- |
| **`macOS 14 Sonoma`** | Yes ✅ |
| **`macOS 13 Ventura`** | Yes ✅ |
| **`macOS 12 Monterey`** | Yes ✅ |
| **`macOS 11 Big Sur`** | Yes ✅ |
Supported Awk and UNIX shells
`tmbackup` is built for `macOS` using `/bin/sh` and `/usr/bin/awk`. It
adheres to standards when possible, and is made to play nicely with other Awk
and POSIX sh versions too.
This allows to execute `tmbackup` with different shells:
```sh
dash /path/to/tmbackup.sh
```
Or to build your own parsing with different Awk implementations:
```sh
tmutil destinationinfo | mawk -f /path/to/tmbackup.awk
```
#### Supported Awk implementations
| Shell | Version | Supported |
| --------: | :--------------- | :-------- |
| [`awk`] | `20230909` | ✅ Yes |
| [`gawk`] | `5.3.0` | ✅ Yes |
| [`goawk`] | `1.25.0` | ✅ Yes |
| [`mawk`] | `1.3.4-20231126` | ✅ Yes |
#### Supported shells
| Shell | Version | Supported |
| --------: | :------------ | :-------- |
| [`bash`] | `5.2.15` | ✅ Yes |
| [`dash`] | `0.5.12` | ✅ Yes |
| [`ksh93`] | `93u+m/1.0.7` | ✅ Yes |
| [`mksh`] | `59c` | ✅ Yes |
| [`oksh`] | `7.3` | ✅ Yes |
| [`osh`] | `0.18.0` | ✅ Yes |
| [`posh`] | `0.14.1` | ❌ No |
| [`yash`] | `2.55` | ✅ Yes |
| [`zsh`] | `5.9` | ✅ Yes |
### UX & Implementation
More information on this topic: [UX.md](doc/UX.md).
> [!NOTE]
> _If you have any cool ideas or suggestions to improve things, let me
> know!_
### Limitations
> [!IMPORTANT]
> _`tmbackup` does not differentiate between backups interrupted by a
> hardware failure and a user manually skipping._
## Acknowledgments
Thanks to [@0risc] and [@goldbuick] for testing and feedback.
## License
`tmbackup` is licensed under the terms of the [MIT License].
See the [LICENSE](LICENSE) file for details.
## Related Projects
- [matteocorti/tmstatus.sh] - general overview and stats
- [torstenvl/tmutils] - history, marking and deduplication
- [emrekaankocoglu/disposable-timemachine-docker] - disposable container
backups
- [raphaelcohn/os-x-backup] - encrypted backups to cloud storage
- [Delvien/Timemachine-mount-usb-backup-then-dismount] - mount drive,
backup, dismount
- [tjluoma/texbar-timemachine] - monitor Time Machine status
- [fedekrum/Mac-Time-Machine-status] - get info on what Time Machine is
doing
- [tomtaylor/fix_timemachine] - fix broken Time Machine NAS backups
[^1]: Tested with [`hyperfine`].
[`agg`]: https://github.com/asciinema/agg
[`asciinema`]: https://github.com/asciinema/asciinema
[`hyperfine`]: https://github.com/sharkdp/hyperfine
[`brew`]: https://brew.sh/
[macOS]: https://www.apple.com/macos/
[MIT License]: https://opensource.org/license/mit/
[Time Machine]: https://support.apple.com/en-gb/guide/mac-help/mh35860/14.0/mac/14.0
[@goldbuick]: https://github.com/goldbuick
[@0risc]: https://github.com/0risc
[`awk`]: https://www.cs.princeton.edu/~bwk/btl.mirror/
[`gawk`]: https://www.gnu.org/software/gawk/
[`goawk`]: https://benhoyt.com/writings/goawk/
[`mawk`]: https://invisible-island.net/mawk/
[`bash`]: https://git.savannah.gnu.org/cgit/bash.git/
[`dash`]: https://git.kernel.org/pub/scm/utils/dash/dash.git
[`ksh93`]: https://github.com/ksh93/ksh
[`mksh`]: https://github.com/MirBSD/mksh
[`osh`]: https://www.oilshell.org/cross-ref.html?tag=OSH#OSH
[`oksh`]: https://github.com/ibara/oksh
[`posh`]: https://salsa.debian.org/clint/posh
[`yash`]: https://github.com/magicant/yash
[`zsh`]: https://github.com/zsh-users/zsh
[matteocorti/tmstatus.sh]: https://github.com/matteocorti/tmstatus.sh
[torstenvl/tmutils]: https://github.com/torstenvl/tmutils
[emrekaankocoglu/disposable-timemachine-docker]: https://github.com/emrekaankocoglu/disposable-timemachine-docker
[raphaelcohn/os-x-backup]: https://github.com/raphaelcohn/os-x-backup
[Delvien/Timemachine-mount-usb-backup-then-dismount]: https://github.com/Delvien/Timemachine-mount-usb-backup-then-dismount
[tjluoma/texbar-timemachine]: https://github.com/tjluoma/textbar-timemachine
[fedekrum/Mac-Time-Machine-status]: https://github.com/fedekrum/Mac-Time-Machine-status/tree/main
[tomtaylor/fix_timemachine]: https://github.com/tomtaylor/fix_timemachine