Contents Menu Expand Light mode Dark mode Auto light/dark, in light mode Auto light/dark, in dark mode Skip to content
CrafterCMS v3.1.31
Light Logo Dark Logo
  • current
  • v4.1
  • v4.0
  • v3.1
  • Getting Started
    • Requirements and Supported Platforms
    • Quick Start Guide
    • Your First Website
  • Content Authors
    • Getting Started on Authoring
    • Navigating Around Crafter Studio
    • Working with Pages
    • Working with Assets
    • Content Author Search
    • Targeting
    • Workflows
  • Developers
    • CrafterCMS Architecture
    • Content Modeling
      • Page Content Type
      • Component Content Type
    • Content Inheritance
    • Assets
      • Remote Assets
      • Asset Processing
    • Templates
      • FreeMarker (Templating) API
      • In-Context Editing
    • Search with Elasticsearch
    • GraphQL
      • Working with GraphQL
      • Custom GraphQL Schema
    • Plugins
      • Blueprints
      • Crafter Studio Plugins
        • Crafter Studio Sidebar Plugin Example
        • Building Form Engine Control Plugins
        • Building Form Engine Data Source Plugins
        • Crafter Studio Plugin Host Page Examples
    • Content Targeting
    • Redirects
    • Testing
    • Errors
    • Extending Crafter Studio
      • Build a Form Engine Control
      • Build a Form Engine Data Source
    • Developer Workflow (DevContentOps)
      • Introduction to the Developer Workflow with CrafterCMS
      • Code Repository & DevOps Workflow
      • Connecting the Production CMS to the Development Workflow
      • Configuration and Implementation Production Content Repository <–> Code Repository Sync and Code Release Publishing
      • Implementation of the DevOps Workflow
    • CrafterCMS
    • Crafter Docker Compose
    • Crafter Core
      • Crafter Core API
        • Clear
        • Clear All
        • Get Descriptor
        • Get Item
        • Get Children
        • Get Tree
    • Crafter Commons
    • Crafter Engine
      • JavaScript Libraries
      • GraphQL
        • Working with GraphQL
        • Custom GraphQL Schema
      • Crafter Engine API
        • Get ID
        • Get Status
        • Destroy Context
        • Rebuild Context
        • Rebuild GraphQL Schema
        • List Jobs
        • Reload Mappings
        • Clear
        • Statistics
        • Get Descriptor (deprecated)
        • Get Item
        • Get Children
        • Get Tree
        • Get Profile
        • Set Profile
        • Breadcrumb
        • Tree
        • Transform
        • Search
        • Query (GET)
        • Query (POST)
        • Preview
        • Get Memory Stats
        • Get Status
        • Get Version
        • Get Log Events
        • Get Component
      • FreeMarker (Templating) API
      • Groovy API
    • Crafter Studio
      • Crafter Studio API
        • Crafter Studio API Version 1
          • Clear Configuration Cache
          • Create Site
          • Delete Site
          • Exists
          • Get Available Blueprints
          • Get Canned Message
          • Get Configuration
          • Get Site
          • Get Sites per User
          • Monitor Content
          • Write Configuration
          • Add Remote (deprecated)
          • Pull From Remote (deprecated)
          • Push To Remote (deprecated)
          • Rebuild Database (deprecated)
          • Remove Remote (deprecated)
          • Sync from Repo
          • List Remote Repositories (deprecated)
          • Login
          • Logout
          • Validate Session
          • Get User Permissions
          • Get User Roles
          • List CMIS Files and Folders (deprecated)
          • Search CMIS (deprecated)
          • Clone a CMIS File into Studio (deprecated)
          • Upload an asset File into CMIS (deprecated)
          • Publish Commits
          • Publish Status
          • Start Publisher
          • Stop Publisher
          • Publish Items
          • Reset Staging Publishing Target
          • Get User Activity
          • Post Activity
          • Copy Item
          • Cut Item
          • Get Items
          • Paste Item
          • Get Dependant Items
          • Get dependencies
          • Get Simple Dependencies
          • Calculate Dependencies
          • Bulk Go Live
          • Get available publishing channels
          • Get Deployment History
          • Get Scheduled Items
          • Preview Sync
          • Change Template
          • Content Exists
          • Create Folder
          • Crop Image
          • Rename Folder
          • Get Content
          • Get Content at Path
          • Get Content Type
          • Get Content Types
          • Get Content Item
          • Get Item Orders
          • Get Item States
          • Get Item Versions
          • Get Items Tree
          • Get Next Item Order
          • Get Pages
          • Reorder Content Items
          • Revert Content Item
          • Search Content
          • Set Item State
          • Unlock Content Item
          • Write Content
          • Get Available Languages
          • Get Loggers
          • Get UI Resource Override
          • Set Logger State
          • Create Jobs
          • Get Go Live Items
          • Get Workflow Affected Paths
          • Go Delete
          • Go Live
          • Reject
          • Request Publishing
          • Transcode
          • MediaConvert (deprecated)
          • AWS S3 Upload (deprecated)
    • Crafter Search
      • Crafter Search API
        • Create Index
        • Get Index Info
        • Delete Index
        • Search Documents
        • Update XML Document
        • Update Binary Document
        • Commit Changes
        • Delete Document
        • Get Memory Stats
        • Get Status
        • Get Version
    • Crafter Deployer
      • Crafter Deployer API
        • Create Target
        • Get Target
        • Get All Targets
        • Delete Target
        • Deploy Target
        • Deploy All Targets
        • Unlock Target
        • Recreate Index
        • Version
        • Status
        • Memory
    • Crafter Profile
      • Crafter Profile API
        • Create Access Token
        • Get Access Token
        • Get All Access Tokens
        • Delete Access Token
        • Create Tenant
        • Get Tenant
        • Update Tenant
        • Delete Tenant
        • Count Tenants
        • Get All Tenants
        • Verify New Profiles
        • Add Roles
        • Remove Roles
        • Add Attributes
        • Update Attributes
        • Remove Attributes
        • Create Profile
        • Update Profile
        • Verify Profile
        • Enable Profile
        • Disable Profile
        • Add Roles
        • Remove Roles
        • Get Attributes
        • Update Attributes
        • Remove Attributes
        • Delete Profile
        • Get Profile By Query
        • Get Profile
        • Get Profile By Username
        • Get Profile By Ticket
        • Get Profile Count
        • Get Profile Count By Query
        • Get Profiles By Query
        • Get Profiles By Ids
        • Get Profiles By Range
        • Get Profiles By Role
        • Get Profiles By Attribute Value
        • Reset Password
        • Change Password
        • Create Verification Token
        • Get Verification Token
        • Delete Verification Token
        • Upload Profile Attachment
        • Get Profile Attachment
        • Get All Profile Attachments
        • Get Profile Attachment Details
        • Authenticate
        • Create Ticket
        • Get Ticket
        • Invalidate Ticket
        • Create Persistent Login
        • Get Persistent Login
        • Refresh Persistent Login
        • Delete Persistent Login
        • Get Memory Stats
        • Get Status
        • Get Version
    • Crafter Social
      • Crafter Social API
        • Get Current Actions
        • Update Actions
        • Get All Social Contexts
        • Create Social Context
        • Add Profile To Social Context
        • Remove Profile from Social Context
        • Update Email Configuration
        • Get Email Configuration
        • Update Email Template
        • Get Email Template
        • Get Context Preferences
        • Update Context Preferences
        • Delete Context Preferences
        • Clear Cache
        • Create Comment
        • Update Comment
        • Delete Comment
        • Get Comment
        • Search Comments
        • Update Comment Attributes
        • Delete Comment Attributes
        • Update Comment Flags
        • Delete Comment Flag
        • Get Comment Flags
        • Moderate Comment
        • Get Comments By Moderation Status
        • Count Comments By Moderation Status
        • Get Flagged Comments
        • Count Flagged Comments
        • Get Attachments
        • Get Attachment Content
        • Create Attachment
        • Delete Attachment
        • Update Attachment Content
        • Vote Up
        • Vote Down
        • Remove Votes
        • Get Thread Comments
        • Get Comment Children
        • Subscribe
        • Update Subscription
        • Unsubscribe
        • Get Memory Stats
        • Get Status
        • Get Version
    • Cookbooks / Tutorials
      • Querying Content
        • Basic Query Mechanics
      • Solutions: Active Cache
        • Active Cache a RESTful Response
      • Solutions for Activiti
        • Start an Activiti Process via Rest Script
      • Solutions for AWS
        • Use S3 to store assets
        • Upload and Transcode Video using AWS Elemental MediaConvert
      • Solutions for Box
        • Use Box to store assets
      • Solutions RESTful Services
        • Render Page Components as JSON
        • Get the Names of Sites Running in Crafter Engine
        • Get Pages for a Given Site
      • GraphQL
        • Working with GraphQL
        • Custom GraphQL Schema
      • Crafter Marketplace
        • Create Plugins for the Crafter Marketplace
      • Best Practices
        • Best Practices on Loading Content From Disk vs Search Index
        • Environment Specific Configurations
      • How-Tos
        • How to Add to Upgrade Scripts for Your Customizations
        • Changing the Data and Logs Folder Location
        • Configuring Crafter on Docker for Local Development Tools
        • Integrating CrafterCMS with cloud hosted developer platforms
          • Integrating CrafterCMS with BitBucket
          • Integrating CrafterCMS with GitHub
          • Integrating CrafterCMS with GitLab
        • Overriding Logging Levels
        • Setting up an LDAP server for development/testing using Apache Directory Studio
        • Using War Overlays with Crafter Engine
        • Using Custom Processors with Crafter Deployer
        • Web Manifest Usage in CrafterCMS
        • Working with Crafter Studio’s APIs
        • Working with Dates and Time Zones in Freemarker
        • Working with Dates and Time Zones in Groovy
        • Working With URL Interceptor/Servlet Filters in CrafterCMS
        • Migrating a site from Solr to Elasticsearch
      • RTE How-tos
        • Using Components in the Rich Text Editor (RTE)
        • Inserting Links to Pages in the Rich Text Editor (RTE)
        • Upgrading to RTE TinyMCE 5
  • Site Administrators
    • Navigating Site Config
    • Configuration
      • Studio Configuration
        • Asset Processing Configuration
        • AWS Profiles Configuration
        • Blob Stores Configuration
        • Box Profiles Configuration
        • CMIS Configuration
        • Code Editor Configuration
        • Configure Simple Workflow Notifications and Dialog Messages
        • Content Monitoring
        • Contextual Navigation Configuration
        • Dependency Resolver Configuration
        • Drag and Drop Configuration
        • Mime Types Configuration
        • Permission Mappings
        • Preview Panel Configuration
        • Role Mappings
        • Rich Text Editor Configuration
          • Rich Text Editor (RTE TinyMCE 2) Setup
          • Rich Text Editor (RTE TinyMCE 5) Setup
        • Sidebar Configuration
        • Site Configuration
        • Site Config Tools
        • Site Config Configuration
        • Targeting Configuration
        • WebDAV Profiles Configuration
        • Multi-Environment Configuration
        • Publishing Assets in External Storage
      • Engine Configuration
        • Engine Site Configuration
        • Engine Site Security Guide
        • Engine SAML2 Configuration
        • Engine Headers Based Authentication
        • Engine Crafter Profile Configuration
        • Content Targeting Guide
        • Configure Engine to use MongoDB
        • Configuring URL Rewriting
        • Engine Multi-Environment Configuration
        • Engine Multi-Target Configuration
        • Proxy Configuration
    • Viewing Logs Through Crafter Studio
  • System Administrators
    • Installing
      • Requirements and Supported Platforms
      • Setting up a CrafterCMS production environment
      • Setup CrafterCMS Authoring Using Crafter’s AWS AMI
      • Setup CrafterCMS Delivery Using Crafter’s AWS AMI
    • Backup and Recovery
    • Studio Clustering
      • Setup a Two Node Cluster with Studio and a Studio Arbiter
      • Setup Studio Clustering with Kubernetes Deployment
      • Changing the Cluster Git URL
    • DevContentOps Toolkit
      • Crafter CLI Commands
        • add-environment
        • add-remote
        • create-site
        • list-remotes
        • sync-from
        • sync-to
    • Logging
    • Setting up a CrafterCMS production environment
    • Reindexing Content for Search and Queries
    • Reindexing Content Without Disrupting Service in Production
    • Troubleshooting CrafterCMS
      • Debugging Search Issues
      • Debugging Publishing Issues
      • Debugging Deployer Issues
      • Debugging SSH Key Issues
      • Debugging SSL Handshake Issues
      • Debugging Maven Issues
    • Randomize “admin” Password for CrafterCMS Fresh Install
    • Configuring Studio Security
      • Studio SAML2 Configuration
      • Configure LDAP Authentication
      • Configure Headers Based Authentication
    • Configure SSL/TLS
    • Setup CloudFront Signed Cookies in CrafterCMS
    • Deploying CrafterCMS in Kubernetes
      • Deploying a Simple CrafterCMS installation in Kubernetes
      • Simple Authoring with a Single Instance Kubernetes Deployment
      • Setup Studio Clustering with Kubernetes Deployment
      • Simple Delivery Kubernetes Deployment
    • Adding a New Language
    • Encrypting Configuration Properties
    • Management Tokens
    • Upgrading CrafterCMS
      • Upgrading CrafterCMS
      • Docker/Kuber Instructions for Upgrading CrafterCMS
    • Authoring Environment Performance Tuning
    • How To Change the Hosts and Ports on Your CrafterCMS Authoring Environment Installation
    • Configuring Publishing to Staging Target
    • Setup CrafterCMS Authoring Using Crafter’s AWS AMI
    • Synchronize Studio Database With Repository
    • Navigating the Main Menu
    • Users/Groups Management
      • Users Management
      • Groups Management
      • Roles and Permissions
      • Putting it all together - Users, Groups, Roles and Permissions
      • User passwords
    • How To Change the Hosts and Ports on Your CrafterCMS Delivery Environment Installation
    • Configuring Apache Virtual Host for Production
    • Delivery Environment Performance Tuning
    • Setup Site for a Delivery Environment
    • Setup Serverless Delivery
    • Setup CrafterCMS Delivery Using Crafter’s AWS AMI
    • Using the Encryption Tool
    • Deployer System Administration Guide
    • Deployer Processors Guide
    • Target Templates Guide
    • Debugging Deployer Issues
    • Elasticsearch Configuration Guide
    • Configure Multi-Tenancy in Engine
    • Configure Single-Tenancy in Engine
    • Turn Off Show Error
    • Engine’s Configuration Overrides
    • Crafter Profile System Administration
    • Crafter Profile Admin Console UI
      • Accessing the Admin Console
      • Access Tokens Management
      • Tenants Management
      • Profiles Management
    • Crafter Search System Administration
    • Crafter Social System Administration
    • Crafter Social Admin Console UI
      • Accessing the Admin Console
      • Social Contexts Management
      • Security Actions Management
      • Preferences Management
      • Profiles Management
      • User Generated Content Moderation
    • Studio’s Configuration Overrides
    • Debugging Publishing Issues
    • Debugging Upgrade Issues
    • Site Creation with Remote Repositories
    • Changing the Session Timeout
    • Publishing Blacklist
  • Security
    • Security Policies
    • Security Advisories
    • Security Processes
  • Release Notes
  • Roadmap
  • Contribute
    • Documentation Standard
  • Source Code
  • Support
  • FAQ
  • Acknowledgements
    • »
  • System Administrators »
  • DevContentOps Toolkit »
  • Crafter CLI Commands
  • Document Up to Date
Back to top
Edit this page

Crafter CLI Commands¶

Note

The connection to CrafterCMS needs to be setup via the add-environment command before using the rest of the commands listed.

  • add-environment
  • add-remote
  • create-site
  • list-remotes
  • sync-from
  • sync-to
Next
add-environment
Previous
DevContentOps Toolkit
Main Site Blog Crafter Cloud Contact
Copyright © 2025, Crafter Software Corporation
Made with Sphinx and @pradyunsg's Furo