campaign-cli 0.7.3 → 0.7.5

package/README.md

@@ -1,238 +1,76 @@
-# Campaign CLI
+**acc, the command line interface for Adobe Campaign developers**
 
-**A command-line interface for ACC (Campaign Classic) developers**
+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.
 
-[![License: AGPL v3](https://img.shields.io/badge/License-AGPL_v3-blue.svg)](https://www.gnu.org/licenses/agpl-3.0)
-[![Node.js](https://img.shields.io/badge/Node.js-22+-green.svg)](https://nodejs.org)
-[![npm](https://img.shields.io/badge/npm-CLI-blue.svg)](https://www.npmjs.com/)
+Full article in the blog post [Getting started with acc](https://myrosblog.com/adobe-campaign/acc-cli-use-cases?utm_campaign=readme)
 
-## 🚀 Quick Start
+## Features
 
-### Quick usage
+- Download all Marketing content: Campaigns, Deliveries, Web apps, and more!
+- Download all Technical content: Data schemas, Javascript codes & pages, Workflows and more!
+- Replace manual exports with scriptable, auditable, and repeatable operations
+- Decompose sources into codes (JS, HTML, CSS) and metadata (fields @created, @lastModified…)
+- Allow local code checkers, highlighters and linters
+- Work on any instance: local, staging, production ; and any OS: Windows, macOS, Linux
 
-```bash
-acc auth init --host https://instance.com --user username --password --alias staging
-
-acc instance pull --alias staging
-# Downloaded /Administration/Configuration/Form rendering
-# Downloaded /Administration/Configuration/Dynamic Javascript pages
-```
+## 🚀 Quick Start
 
-### Quick installation
+### Quick usage
 
 ```bash
 $ npm install -g campaign-cli
-$ acc # check installation
-```
-
-### Basic Usage
-
-Folder structure recommendation, under a local folder, i.e. `Downloads`
-
-```bash
-/Downloads/
-├── campaign-cli/                  # Clone of this source code
-│
-├── instance1-staging/             # Staging Instance 1
-│   ├── config/                          # Instance-specific config => automatically created with acc check
-│   │   └── acc.config.json
-│   └── Administration/Configuration/    # Downloaded schemas => automatically downloaded with acc pull
-│       ├── schema1.xml
-│       └── schema2.xml
-│
-└── instance1-production/          # Production Instance 2
-    ├── config/
-    │   └── acc.config.json
-    └── Administration/Configuration/
-        ├── schema1.xml
-        └── schema2.xml
-```
-
-#### Step 1: Configure an ACC Instance
-
-```bash
-acc auth init \
-  --host http://localhost:8080 \
-  --user admin \
-  --password admin \
-  --alias local
-```
-
-This command:
-
-- Saves credentials securely in your config store
-- Tests the connection to your ACC instance
-- Lists available schemas and record counts
-
-#### Step 2: Pull Data from Your Instance with default configuration
-
-```bash
-acc instance check --alias local
-acc instance pull --alias local
-```
-
-This command:
-
-- Creates a local directory structure
-- Downloads schema definitions as XML files
-- Preserves original naming conventions
-- Implements pagination for large datasets
 
-#### Step 2-bis: Pull Data from Your Instance with custom configuration
+$ acc auth init --host https://instance.com --user username --password --alias staging
 
-Create
-
-```bash
-
-```
-
-## 📚 Features
-
-### Authentication Management
-
-```bash
-# List all configured instances
-acc auth list
-
-# Troubleshoot IP via https://api.db-ip.com/v2/free/self @see https://opensource.adobe.com/acc-js-sdk/connecting.html
-acc auth ip
-
-# Login to an existing instance
-acc auth login --alias prod
-
-# Initialize a new instance
-acc auth init --alias staging --host https://staging.example.com
-```
-
-### Data Operations
-
-```bash
-# Check instance (count records without downloading)
-acc instance check --alias prod
-
-# Pull data with custom config
-acc instance pull \
-  --alias prod \
-  --path ./my-project/data \
-  --config ./config/acc.config.json
-```
-
-### Configuration Management
-
-Create a `acc.config.json` file to customize data pulling:
-
-```json
-{
-  "nms:delivery": {
-    "filename": "Deliveries/{%name%}.xml",
-    "queryDef": {
-      "where": {
-        "condition": [{ "expr": "@builtIn = false AND @isModel = true" }]
-      }
-    }
-  }
-}
-```
-
-## 🎯 Use Cases
-
-### For ACC Developers
-
-```bash
-# Setup development environment
-acc auth init --alias dev --host http://localhost:8080
-
-# Pull specific schemas
-acc instance pull --alias dev
-
-# Regular data refresh
-acc instance pull --alias prod --path ./backup/$(date +%Y-%m-%d)
-```
-
-### For DevOps Teams
-
-```bash
-# CI/CD integration
-acc auth init --alias ci --host $ACC_HOST --user $ACC_USER --password $ACC_PASSWORD
-acc instance check --alias ci || exit 1
-
-# Automated backups
-acc instance pull --alias prod --path /backups/acc/$(date +%Y-%m-%d)
-```
-
-### For Data Analysts
-
-```bash
-# Quick data extraction
-acc instance pull --alias analytics --config ./config/analytics.config.json
-
-# Schema documentation
-acc instance check --alias prod > schema_report.txt
-```
-
-## 🔧 Advanced Configuration
-
-### Custom Paths and Configs
-
-```bash
-acc instance pull \
-  --alias staging \
-  --path /projects/acc-migration/data \
-  --config ./config/migration.config.json
+$ acc instance pull --alias staging
+# Downloaded /Administration/Configuration/Form rendering
+# Doanloaded /Administration/Configuration/Dynamic Javascript pages
 ```
 
-### Filename Patterns
-
-Available variables for filename patterns:
+### 🔧 Advanced Configuration
 
-- `%schema%` - Schema name (e.g., `nms_recipient`)
-- `%namespace%` - Schema namespace
-- `%name%` - Schema display name
-- `%internalName%` - Internal schema name
+[Advanced use cases with acc](https://myrosblog.com/adobe-campaign/acc-cli-use-cases?utm_campaign=readme)
 
 ## 🤝 Contributing
 
-Contributions are welcome! Please open a Pull Request!
+Contributions are welcome! Please open a Github Pull Request!
 
 ### Local development
 
 ```bash
 # Clone repository
-git clone https://github.com/myrosblog/acc-cli.git
-cd acc-cli
-npm install
-npm link
-npm test
+git clone https://github.com/myrosblog/acc-cli.git && cd acc-cli
+npm install && npm test
 ```
 
 ### Project Structure
 
 ```
 src/
-├── main.js               # CLI entry point
-├── CampaignAuth.js       # Authentication and instance management
-├── CampaignInstance.js   # Data operations (check, pull, download)
-└── CampaignError.js      # Custom error handling
+├── main.js                  # CLI entry point
+├── CampaignAuth.js          # Authentication and instance management
+├── CampaignInstance.js      # Data operations (check, pull, download)
+└── CampaignError.js         # Custom error handling
 
 test/
-├── CampaignAuth.spec.js  # Authentication tests
+├── CampaignAuth.spec.js     # Authentication tests
 ├── CampaignInstance.spec.js # Data operation tests
-└── CampaignError.spec.js  # Error handling tests
+└── CampaignError.spec.js    # Error handling tests
 
 bin/
-└── acc            # Executable wrapper
+└── acc                      # Executable wrapper
 
 config/
-└── acc.config.json # Default configuration template
+└── acc.config.json          # Default configuration template
 ```
 
 ## Roadmap
 
-- Publish to npm
+- `acc instance push`
 
 ## 🔒 Security
 
-- Credentials are stored securely using `configstore`
+- Credentials are stored securely using `configstore` outside of version controlled folders
 - No credentials are logged or transmitted unnecessarily
 - All network communications use the official ACC JS SDK
-- Regular dependency updates for security patches
+- 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

@@ -1,15 +1,16 @@
 {
   "name": "campaign-cli",
-  "version": "0.7.3",
+  "version": "0.7.5",
   "description": "Save time, reduce risk and improve code health with acc CLI",
   "keywords": [
     "adobe",
     "adobe campaign",
     "adobe campaign classic",
-    "acc"
+    "acc",
+    "devops"
   ],
   "bin": {
-    "acc": "./bin/acc"
+    "acc": "bin/acc"
   },
   "preferGlobal": true,
   "files": [

package/src/main.js

@@ -26,11 +26,12 @@ const pathConfig = "config.path";
 console.log(
   `🏠 acc ${vAcc} initialized with Adobe acc-js-sdk ${vSdk} and authentication from ${pathConfig}`,
 );
+const homepage = packageJson.homepage.replace('utm_campaign=acc-cli', 'utm_campaign=package-json')
 
 program
   .name("acc")
   .description(
-    `${packageJson.description}. Documentation on ${packageJson.homepage}`,
+    `${packageJson.description}. Documentation on ${homepage}`,
   )
   .version(vAcc);