dc-cli/HOW_TO_USE.1 at master · amplience/dc-cli · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
.\" generated with Ronn/v0.7.3
.\" http://github.com/rtomayko/ronn/tree/0.7.3
.
.TH "DC\-CLI" "1" "January 2022" "" ""
.
.SH "NAME"
\fBdc\-cli\fR \- (Amplience) Dynamic Content command line interface
.
.SH "SYNOPSIS"
\fBdc\-cli\fR \fB<command>\fR \fB[args]\fR
.
.SH "DESCRIPTION"
\fBdc\-cli\fR is a command line interface application for Amplience Dynamic Content management APIs\.
.
.P
Run \fBdc\-cli\fR to get a list of available commands
.
.SH "CONFIGURATION"
\fBdc\-cli\fR requires a valid set of Amplience client credentials (\fB\-\-clientId\fR & \fB\-\-clientSecret\fR) and hub ID (\fB\-\-hubId\fR) to operate\. These must be supplied for each command or alternatively they can saved to a user\-level configuration file using \fBdc\-cli configure\fR\.
.
.P
By default the configuration file is saved into the directory \fB<HOME_DIR>/\.amplience/\fR, this can be overridden using the \fB\-\-config\fR option\.
.
.P
See \fBdc\-cli configure \-\-help\fR for more information\.
.
.SH "FACETS"
The content item export, copy, move archive and unarchive commands allow the user to provide a facet string to filter the content that the commands work on\. Multiple of these can be applied at a time, and you can even match on regex string\. Note that you will need to surround your facet in quotes if it contains a space, which will change how backslash escaping works\.
.
.IP "\(bu" 4
\fBname\fR: Filter on content item label\. Example: \fB\-\-facet "name:exact name match"\fR
.
.IP "\(bu" 4
\fBschema\fR: Filter on schema ids\. Example: \fB\-\-facet schema:http://example\.com/schema\.json\fR
.
.IP "\(bu" 4
\fBlocale\fR: Filter on content item locale\. Example: \fB\-\-facet locale:en\-GB\fR
.
.IP "\(bu" 4
\fBlastModifiedDate\fR: Filter on last modified date\. Example: \fB\-\-facet "lastModifiedDate:Last 7 days"\fR
.
.IP "" 0
.
.P
Multiple facets can be applied at once when separated by a comma\. Example: \fB\-\-facet "schema:http://example\.com/schema\.json, name:/name regex/"\fR
.
.P
Commas can be escaped with a backslash, if they are used in your values\. The whitespace after a comma is optional\.
.
.SS "PRESET DATE RANGES"
The preset date ranges are the same as DC provides: \- \fBLast 7 days\fR \- \fBLast 14 days\fR \- \fBLast 30 days\fR \- \fBLast 60 days\fR \- \fBOver 60 days\fR
.
.SS "REGEX"
You can use regex values on string fields when filtering content\. They cannot be used on date ranges\. Regex are surronded by two forward slashes: \fB\-\-facet "name:/ends with this$/"\fR
.
.SH "SEE ALSO"
.
.IP "\(bu" 4
\fBdc\-cli \-\-help\fR
.
.IP "\(bu" 4
\fBdc\-cli <command> \-\-help\fR
.
.IP "\(bu" 4
\fBREADME\.md\fR
.
.IP "\(bu" 4
https://docs\.amplience\.net/
.
.IP "" 0