cmbox-cli

cmbox Command Line Interface for CM Box

Requires CM Box v1.4.10 or greater for full functionality.

Command List

init

import

import types

import taxonomies

import assets

import site

import site_types

servers

servers add

servers delete

types sync

items delete_by_query

Flags

All commands will prompt the user for the required information, however flags can be used to bypass their respective prompts.

Import Flags

• --server: target CM Box server listed in servers.json
• --repo: target CM Box repository
• --site: target CM Box site
• --source: content source

CM Box Content Source

• --sourceServer: source CM Box server listed in servers.json
• --sourceRepo: source CM Box repository
• --sourceSite: source CM Box site

OCM Site Export Content Source

• --path: full filepath of unzipped OCM Site Export folder
• --mapping: migration mapping file for OCM to CM Box conversion

Commands

cmbox init

Generates the servers.json that stores the user's CM Box server details.

servers.json is required for the other commands to work.

Import Commands

Supports importing content to target CM Box server from the following sources:

• CM Box
• Oracle Content Management (OCM) Site Export

cmbox import

Prompts user to select one of import commands.

1st argument specifies the command and skips the prompt.

cmbox import types

Imports types from content source to target CM Box server and adds them to target repository.

cmbox import taxonomies

Imports taxonomies from content source to target CM Box server and adds them to target repository.

cmbox import assets

Imports assets from content source to target CM Box repository. On server configuration, an ASSET_MAP.json will be created which will allow for custom mapping for fields.

Additional Flags:

--newOnly: Only import new assets with IDs that do not yet exist in target repository.

Requirements:

• Target repository must already exist.
• Asset types must exist in the repository prior to import assets.

cmbox import site

Imports site structure from content source to target CM Box site.

Requirements

• Target site must already exist.
• Referenced assets must already exist in target site's repository.

cmbox import site_types

• Only used for OCM Site Export content source
• Multi-step process that requires manual editing.

Servers Commands

cmbox servers

Manage CM Box servers for CLI use.

Provides options to add, reauthenticate, or delete servers in servers.json.

cmbox servers add

Adds a server to servers.json by prompting user for hostname and login information.

Passing the following flags will bypass the prompts:

• --url: protocol and hostname of server
• --username: username for server

Automatically collects token after successful login.

Generates an ASSET_MAP.json for custom asset mapping to this server.

cmbox servers delete

Deletes server from servers.json.

Additional Commands

cmbox types sync

Sync types from one CM Box instance to another.

cmbox items delete_by_query

Query to delete all assets in a repository is " ".

--showArchive: includes archived items in the query for deletion.

cmbox items regenerate_by_query

Query to regenerate renditions for all assets in a repository is " ".

--showArchive: includes archived items in the query for regeneration.