The MSPro Boomi Collection
About
Boomi Console
Boomi Console
  • Boomi Console
    • What is ...
  • Installation & Setup
    • Download & Install
    • Setup a Workspace
    • Connect your Workspace
    • Test your Workspace
  • Commands
    • COMP - Components
      • GET
      • DOC
    • PACK - Packaged Components
      • PACK GET
      • PACK DOC
    • DEPLOY - Deployments
      • GET - Deployments and Packages
      • EXEC - Deploy components
        • Deployment from Repos
        • Promotion to Env
      • DELETE - Undeploy Components
    • WORKSPACE CONNECT
    • ACCOUNT INFO
    • Arguments
      • Common Arguments
        • The Set Argument in Detail
        • Query Filter
          • Start date or time span
        • Arguments in a file
        • Allow Multi
        • Component Resolution
      • COMP Arguments
        • COMP GET Arguments
        • COMP DOC Arguments
      • PACK Arguments
      • DEPLOY Arguments
        • DEPLOY GET Arguments
        • DEPLOY EXEC Arguments
        • DEPLOY DELETE Arguments
  • Use-Cases
    • Analyze deployed components
    • Components in a Folder
    • Deploy Components
    • Reveal a Process
    • Reveal an API Component
    • Deployed Components Overview
    • Deployment Task Document
    • Create a cSet.jsonc file
  • Library
    • Component Set
      • The Components Set JsonC file
        • Create a package file
      • Set File resolution
    • The Report Engine
      • Render DataSets
        • DataSet Base
        • Component Metadata DataSet
          • Component Metadata Header
          • Component Metadata
          • CompDataSet With Counts
        • Deployed Packages DataSet
        • Package Content DataSet
        • Map Markdown Dataset
      • Components
        • Deployable Components
        • Orphaned Components
    • The Workspace
      • Manage your workspace
      • Components Set Workspace
      • Workspace folders
      • The project database
    • Configuration files
      • Application Settings
      • Workspace configuration file
      • boomiConsole.user.json
    • How to...
      • Use Excel to view CSV files
      • Local metadata and caching
      • Getting help
      • Environments
      • How to get a Component's Id
    • Referenced Pages
      • Lists
      • Documentation Snapshots
  • Download and Release History
  • Help Text
    • Documentation Links
    • Target Path Resolution
    • GitHub Emojis
    • Packaged Component and Versions
    • Components and Versions
    • Component Hierarchy
    • Referenced Components
Powered by GitBook
On this page
  • Command overview
  • Detailed command descriptions
  1. Library
  2. How to...

Getting help

Use the BC help function

BoomiConsole is built on CLArgs and it supports help on the command-line.

Command overview

Open a console windows and run .\bc without any argument and you will get an overview of all available commands:

*** BoomiConsole v3.11.8718.32154 .. Start ***
15 Commands available:
=======================================
Verb                Description
---------------------------------------
Project Configure   Create, update and configure your Boomi-Console project settings.

Print DeploymentTask Print a deployment task based on a template.

Info Account        AtomSphere API - Account Info

Detailed command descriptions

If you want to know more about a specfic command and its supported parameters, run: .\bc <command> help:

.\bc Info Account /help

Info Account        AtomSphere API - Account Info
--------------------------------------------------------------------------------
/ProjectDir         Tags=r,root optional
                    Specify the /ProjectDir that contains the bc.workspace.json. 
                    All other directories are relative to that directory.
                    DEFAULT: <currentDirectory>
/OutDir             Tags=o optional
                    The output root directory. All other output directories are
                    relative to this directory.
                    DEFAULT: 'out'
                    ...

Last updated 10 months ago