xdbm/README.md

# xdbm
_Cross device backup manager_,
to manage backups on several storages mounted on multiple devices with a single repository.

## Usage
1. `xdbm init` to setup new device(i.e. PC).
2. `xdbm storage add` to add storages, or `xdbm storage bind` to make existing storages available on new device.
3. `xdbm backup add` to add new backup configuration.
4. `xdbm backup done` to tell xdbm to write backup execution datetime.
5. `xdbm storage list` and `xdbm backup list` to see their status.

## TODO:
- [x] split subcommands to functions
- [x] write test for init subcommand
  - [x] write test with existing repo
  - [x] with ssh credential
    - [x] ssh-agent
    - [x] specify key
- [ ] write test for storage subcommand
  - [x] storage add online
  - [x] storage add directory
  - [ ] storage list
- [x] update storage bind command
- [ ] add storage remove command
- [ ] add sync subcommand
- [x] add check subcommand
  - [x] check that all parents exist
- [x] reorganize cmd option for storage
  - [x] use subcommand
- [ ] backup subcommands
  - [ ] backup add
    - [ ] test for backup add
  - [ ] backup list
    - [x] status printing
  - [x] backup done
- [ ] fancy display
- [ ] no commit option

<!-- vim: set sw=2 ts=2:  -->
update docs & Cargo.toml 2024-03-17 03:25:44 +09:00			`# xdbm`
			`_Cross device backup manager_,`
			`to manage backups on several storages mounted on multiple devices with a single repository.`

			`## Usage`
			1. `xdbm init` to setup new device(i.e. PC).
			2. `xdbm storage add` to add storages, or `xdbm storage bind` to make existing storages available on new device.
			3. `xdbm backup add` to add new backup configuration.
			4. `xdbm backup done` to tell xdbm to write backup execution datetime.
			5. `xdbm storage list` and `xdbm backup list` to see their status.

			`## TODO:`
change init command & add integration test - now need to specify device name via cmd arg - can use private repository with ssh key or ssh-agent - adding integration test utility crates 2024-03-07 14:59:58 +09:00			`- [x] split subcommands to functions`
init STORAGESFILE and DEVICESFILE at repo init and change Storages.read - return Err instead of new object when there is no STORAGESFILE - setup empty DEVICESFILE and STORAGESFILE at repository initialization - update readme 2024-03-11 08:22:35 +09:00			`- [x] write test for init subcommand`
redesign storage add Commands - replace storage add args with subcommands of physical, directory, online - to make argument dependencies clearer 2024-03-12 16:18:24 +09:00			`- [x] write test with existing repo`
init STORAGESFILE and DEVICESFILE at repo init and change Storages.read - return Err instead of new object when there is no STORAGESFILE - setup empty DEVICESFILE and STORAGESFILE at repository initialization - update readme 2024-03-11 08:22:35 +09:00			`- [x] with ssh credential`
			`- [x] ssh-agent`
			`- [x] specify key`
redesign storage add Commands - replace storage add args with subcommands of physical, directory, online - to make argument dependencies clearer 2024-03-12 16:18:24 +09:00			`- [ ] write test for storage subcommand`
add test for storage add online 2024-03-13 04:25:38 +09:00			`- [x] storage add online`
add test for storage add - failure due to name duplication - success with online & subdirectory with two devices - used local git to write test (TODO?: use only git2) 2024-03-14 06:35:11 +09:00			`- [x] storage add directory`
redesign storage add Commands - replace storage add args with subcommands of physical, directory, online - to make argument dependencies clearer 2024-03-12 16:18:24 +09:00			`- [ ] storage list`
update storage bind 2024-03-13 05:36:19 +09:00			`- [x] update storage bind command`
replace raw HashMap with Storages 2024-03-10 13:00:28 +09:00			`- [ ] add storage remove command`
change init command & add integration test - now need to specify device name via cmd arg - can use private repository with ssh key or ssh-agent - adding integration test utility crates 2024-03-07 14:59:58 +09:00			`- [ ] add sync subcommand`
add check subcommand 2024-03-17 20:02:10 +09:00			`- [x] add check subcommand`
			`- [x] check that all parents exist`
redesign storage add Commands - replace storage add args with subcommands of physical, directory, online - to make argument dependencies clearer 2024-03-12 16:18:24 +09:00			`- [x] reorganize cmd option for storage`
			`- [x] use subcommand`
add test for storage add - failure due to name duplication - success with online & subdirectory with two devices - used local git to write test (TODO?: use only git2) 2024-03-14 06:35:11 +09:00			`- [ ] backup subcommands`
			`- [ ] backup add`
new subcommand: backup list - todo: fancy print 2024-03-15 04:16:57 +09:00			`- [ ] test for backup add`
add test for storage add - failure due to name duplication - success with online & subdirectory with two devices - used local git to write test (TODO?: use only git2) 2024-03-14 06:35:11 +09:00			`- [ ] backup list`
add backup done 2024-03-16 21:31:08 +09:00			`- [x] status printing`
			`- [x] backup done`
new subcommand: backup list - todo: fancy print 2024-03-15 04:16:57 +09:00			`- [ ] fancy display`
redesign storage add Commands - replace storage add args with subcommands of physical, directory, online - to make argument dependencies clearer 2024-03-12 16:18:24 +09:00			`- [ ] no commit option`
change init command & add integration test - now need to specify device name via cmd arg - can use private repository with ssh key or ssh-agent - adding integration test utility crates 2024-03-07 14:59:58 +09:00
			`<!-- vim: set sw=2 ts=2: -->`