campaign-cli 0.7.4 β 0.7.6
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +26 -22
- package/package.json +5 -4
- package/src/main.js +2 -1
package/README.md
CHANGED
|
@@ -1,9 +1,18 @@
|
|
|
1
|
-
|
|
1
|
+
**acc, the command line interface for Adobe Campaign developers**
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Save time, reduce risk, and improve code health with `acc`! This CLI tool helps you build on Adobe Campaign Classic platform. It quickly downloads Adobe Campaign **configuration, campaigns and online resources**. You can also use it to automate many common development tasks.
|
|
4
4
|
|
|
5
5
|
Full article in the blog post [Getting started with acc](https://myrosblog.com/adobe-campaign/acc-cli-use-cases?utm_campaign=readme)
|
|
6
6
|
|
|
7
|
+
## Features
|
|
8
|
+
|
|
9
|
+
- Download all Marketing content: Campaigns, Deliveries, Web apps, and more!
|
|
10
|
+
- Download all Technical content: Data schemas, Javascript codes & pages, Workflows and more!
|
|
11
|
+
- Replace manual exports with scriptable, auditable, and repeatable operations
|
|
12
|
+
- Decompose sources into codes (JS, HTML, CSS) and metadata (fields @created, @lastModifiedβ¦)
|
|
13
|
+
- Allow local code checkers, highlighters and linters
|
|
14
|
+
- Work on any instance: local, staging, production ; and any OS: Windows, macOS, Linux
|
|
15
|
+
|
|
7
16
|
## π Quick Start
|
|
8
17
|
|
|
9
18
|
### Quick usage
|
|
@@ -13,11 +22,9 @@ $ npm install -g campaign-cli
|
|
|
13
22
|
|
|
14
23
|
$ acc auth init --host https://instance.com --user username --password --alias staging
|
|
15
24
|
|
|
16
|
-
$ acc instance check --alias staging
|
|
17
|
-
# Downloaded /Administration/Configuration/Form rendering
|
|
18
|
-
# Downloaded /Administration/Configuration/Dynamic Javascript pages
|
|
19
|
-
|
|
20
25
|
$ acc instance pull --alias staging
|
|
26
|
+
# Downloaded /Administration/Configuration/Form rendering
|
|
27
|
+
# Doanloaded /Administration/Configuration/Dynamic Javascript pages
|
|
21
28
|
```
|
|
22
29
|
|
|
23
30
|
### π§ Advanced Configuration
|
|
@@ -26,38 +33,35 @@ $ acc instance pull --alias staging
|
|
|
26
33
|
|
|
27
34
|
## π€ Contributing
|
|
28
35
|
|
|
29
|
-
Contributions are welcome! Please open a Pull Request!
|
|
36
|
+
Contributions are welcome! Please open a Github Pull Request!
|
|
30
37
|
|
|
31
38
|
### Local development
|
|
32
39
|
|
|
33
40
|
```bash
|
|
34
41
|
# Clone repository
|
|
35
|
-
git clone https://github.com/myrosblog/acc-cli.git
|
|
36
|
-
|
|
37
|
-
npm install
|
|
38
|
-
npm link
|
|
39
|
-
npm test
|
|
42
|
+
git clone https://github.com/myrosblog/acc-cli.git && cd acc-cli
|
|
43
|
+
npm install && npm test
|
|
40
44
|
```
|
|
41
45
|
|
|
42
46
|
### Project Structure
|
|
43
47
|
|
|
44
48
|
```
|
|
45
49
|
src/
|
|
46
|
-
βββ main.js
|
|
47
|
-
βββ CampaignAuth.js
|
|
48
|
-
βββ CampaignInstance.js
|
|
49
|
-
βββ CampaignError.js
|
|
50
|
+
βββ main.js # CLI entry point
|
|
51
|
+
βββ CampaignAuth.js # Authentication and instance management
|
|
52
|
+
βββ CampaignInstance.js # Data operations (check, pull, download)
|
|
53
|
+
βββ CampaignError.js # Custom error handling
|
|
50
54
|
|
|
51
55
|
test/
|
|
52
|
-
βββ CampaignAuth.spec.js
|
|
56
|
+
βββ CampaignAuth.spec.js # Authentication tests
|
|
53
57
|
βββ CampaignInstance.spec.js # Data operation tests
|
|
54
|
-
βββ CampaignError.spec.js
|
|
58
|
+
βββ CampaignError.spec.js # Error handling tests
|
|
55
59
|
|
|
56
60
|
bin/
|
|
57
|
-
βββ acc
|
|
61
|
+
βββ acc # Executable wrapper
|
|
58
62
|
|
|
59
63
|
config/
|
|
60
|
-
βββ acc.config.json
|
|
64
|
+
βββ acc.config.json # Default configuration template
|
|
61
65
|
```
|
|
62
66
|
|
|
63
67
|
## Roadmap
|
|
@@ -66,7 +70,7 @@ config/
|
|
|
66
70
|
|
|
67
71
|
## π Security
|
|
68
72
|
|
|
69
|
-
- Credentials are stored securely using `configstore`
|
|
73
|
+
- Credentials are stored securely using `configstore` outside of version controlled folders
|
|
70
74
|
- No credentials are logged or transmitted unnecessarily
|
|
71
75
|
- All network communications use the official ACC JS SDK
|
|
72
|
-
-
|
|
76
|
+
- All sensitive information are trimmed by the official ACC JS SDK (headers `x-security-token` and `x-session-token`, session tokens) via `_removeBetween`
|
package/package.json
CHANGED
|
@@ -1,15 +1,16 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "campaign-cli",
|
|
3
|
-
"version": "0.7.
|
|
3
|
+
"version": "0.7.6",
|
|
4
4
|
"description": "Save time, reduce risk and improve code health with acc CLI",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"adobe",
|
|
7
7
|
"adobe campaign",
|
|
8
8
|
"adobe campaign classic",
|
|
9
|
-
"acc"
|
|
9
|
+
"acc",
|
|
10
|
+
"devops"
|
|
10
11
|
],
|
|
11
12
|
"bin": {
|
|
12
|
-
"acc": "
|
|
13
|
+
"acc": "bin/acc"
|
|
13
14
|
},
|
|
14
15
|
"preferGlobal": true,
|
|
15
16
|
"files": [
|
|
@@ -45,5 +46,5 @@
|
|
|
45
46
|
"bugs": {
|
|
46
47
|
"url": "https://github.com/myrosblog/acc-cli/issues"
|
|
47
48
|
},
|
|
48
|
-
"homepage": "https://myrosblog.com/adobe-campaign/acc-cli?utm_campaign=
|
|
49
|
+
"homepage": "https://myrosblog.com/adobe-campaign/acc-cli?utm_campaign=package-json"
|
|
49
50
|
}
|
package/src/main.js
CHANGED
|
@@ -26,11 +26,12 @@ const pathConfig = "config.path";
|
|
|
26
26
|
console.log(
|
|
27
27
|
`π acc ${vAcc} initialized with Adobe acc-js-sdk ${vSdk} and authentication from ${pathConfig}`,
|
|
28
28
|
);
|
|
29
|
+
const homepage = packageJson.homepage.replace('utm_campaign=package-json', 'utm_campaign=acc-cli')
|
|
29
30
|
|
|
30
31
|
program
|
|
31
32
|
.name("acc")
|
|
32
33
|
.description(
|
|
33
|
-
`${packageJson.description}. Documentation on ${
|
|
34
|
+
`${packageJson.description}. Documentation on ${homepage}`,
|
|
34
35
|
)
|
|
35
36
|
.version(vAcc);
|
|
36
37
|
|