Skip to content

Commit

Permalink
readme - update
Browse files Browse the repository at this point in the history
  • Loading branch information
MatteoCampinoti94 committed Dec 17, 2024
1 parent abc0acf commit 5781986
Showing 1 changed file with 166 additions and 0 deletions.
166 changes: 166 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,12 @@
* [statutory](#digiarch-edit-statutory)
* [remove](#digiarch-edit-statutory-remove)
* [rollback](#digiarch-edit-rollback)
* [search](#digiarch-search)
* [original](#digiarch-search-original)
* [master](#digiarch-search-master)
* [access](#digiarch-search-access)
* [statutory](#digiarch-search-statutory)
* [log](#digiarch-log)
* [upgrade](#digiarch-upgrade)
* [help](#digiarch-help)
* [completions](#digiarch-completions)
Expand All @@ -49,6 +55,8 @@ Commands:
identify Identify files.
extract Unpack archives.
edit Edit the database.
search Search the database.
log Display the event log.
upgrade Upgrade the database.
help Show the help for a command.
completions Generate shell completions.
Expand Down Expand Up @@ -743,6 +751,164 @@ Options:
--help Show this message and exit.
```

### digiarch search

```
Usage: digiarch search [OPTIONS] COMMAND [ARGS]...
Search files in the database.
Options:
--help Show this message and exit.
Commands:
access Search access files.
master Search master files.
original Search original files.
statutory Search statutory files.
```

#### digiarch search original

```
Usage: digiarch search original [OPTIONS] [QUERY]
Search among the original files in the database.
The wollowing query fields are supported:
* uuid
* checksum
* puid
* relative_path
* action
* warning
* is_binary
* processed
* lock
* original_path
For details on the QUERY argument, see the edit command.
Options:
--sort [relative_path|puid|checksum|action]
Choose sorting column, [default:
relative_path]
--order [asc|desc] Choose sorting order. [default: asc]
--limit INTEGER Limit number of results. [default: 100;
x>=1]
--offset INTEGER Offset number of results. [default: 0;
x>=0]
--help Show this message and exit.
```

#### digiarch search master

```
Usage: digiarch search master [OPTIONS] [QUERY]
Search among the master files in the database.
The wollowing query fields are supported:
* uuid
* checksum
* puid
* relative_path
* warning
* is_binary
* processed
* original_uuid
For details on the QUERY argument, see the edit command.
Options:
--sort [relative_path|puid|checksum]
Choose sorting column, [default:
relative_path]
--order [asc|desc] Choose sorting order. [default: asc]
--limit INTEGER Limit number of results. [default: 100;
x>=1]
--offset INTEGER Offset number of results. [default: 0;
x>=0]
--help Show this message and exit.
```

#### digiarch search access

```
Usage: digiarch search access [OPTIONS] [QUERY]
Search among the access files in the database.
The wollowing query fields are supported:
* uuid
* checksum
* puid
* relative_path
* warning
* is_binary
* original_uuid
For details on the QUERY argument, see the edit command.
Options:
--sort [relative_path|puid|checksum]
Choose sorting column, [default:
relative_path]
--order [asc|desc] Choose sorting order. [default: asc]
--limit INTEGER Limit number of results. [default: 100;
x>=1]
--offset INTEGER Offset number of results. [default: 0;
x>=0]
--help Show this message and exit.
```

#### digiarch search statutory

```
Usage: digiarch search statutory [OPTIONS] [QUERY]
Search among the statutory files in the database.
The wollowing query fields are supported:
* uuid
* checksum
* puid
* relative_path
* warning
* is_binary
* original_uuid
For details on the QUERY argument, see the edit command.
Options:
--sort [relative_path|puid|checksum]
Choose sorting column, [default:
relative_path]
--order [asc|desc] Choose sorting order. [default: asc]
--limit INTEGER Limit number of results. [default: 100;
x>=1]
--offset INTEGER Offset number of results. [default: 0;
x>=0]
--help Show this message and exit.
```

### digiarch log

```
Usage: digiarch log [OPTIONS]
Display the event log.
Start events will display the index to be used to roll back the of that
command.
Options:
--runs-only Only show start/end events.
--order [asc|desc] Choose sorting order. [default: asc]
--limit INTEGER Limit number of results. [default: 100; x>=1]
--help Show this message and exit.
```

### digiarch upgrade

```
Expand Down

0 comments on commit 5781986

Please sign in to comment.