-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
74204e9
commit 59b462e
Showing
1 changed file
with
27 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,2 +1,28 @@ | ||
# amclient | ||
Archivematica API client module | ||
|
||
The transfers/amclient.py script is a module and CLI that provides | ||
functionality for interacting with the various Archivematica APIs. | ||
|
||
Basic usage: | ||
`amclient.py <subcommand> [optional arguments] <positional argument(s)>` | ||
|
||
E.g.: | ||
```bash | ||
amclient.py close-completed-transfers \ | ||
--am-user-name test 234deffdf89d887a7023546e6bc0031167cedf6 | ||
``` | ||
|
||
To see a list of all commands and how they are used, then run `amclient.py` | ||
without any arguments. | ||
|
||
To understand how to use an individual subcommand, simply run: | ||
`amclient.py <subcommand>`, the output will describe the input parameters for | ||
that command: | ||
|
||
E.g.: | ||
```bash | ||
usage: amclient extract-file [-h] [--ss-user-name USERNAME] [--ss-url URL] | ||
[--directory DIR] | ||
[--saveas-filename SAVEASFILENAME] | ||
ss_api_key package_uuid relative_path | ||
``` |