Wisco

Wisco is a small Ruby CLI for working with Workato connector projects.

It helps with three common tasks:

• Detecting a connector file and creating local project configuration
• Inspecting connector structure from the command line
• Running connector field and execute flows through the Workato Connector SDK CLI

The tool is designed for local development against a connector project directory and uses a per-project config file named .wisco.json.

• init discovers a connector file and writes .wisco.json
• list prints a structural overview of a connector
• list actions and list triggers render markdown-friendly tables
• list all combines overview, actions, and triggers output
• exec --mode=fields generates fixture files for input and output fields
• exec --mode=execute runs connector methods with prepared input files

• Ruby 2.7.6
• Bundler
• The gems listed in Gemfile

Current runtime dependencies:

• activesupport ~> 7.0.0
• workato-connector-sdk 1.3.19

Clone the repository and install dependencies:

bundle install

Run the CLI from the repository root:

bundle exec ruby wisco.rb --help

On Windows, you can also use wisco.bat.

From inside a Workato connector project directory:

bundle exec ruby /path/to/wisco.rb init
bundle exec ruby /path/to/wisco.rb list

The init command creates a .wisco.json file in the target directory. That file stores the detected connector path and filename so later commands can load the connector consistently.

Example:

{
  "connector": {
    "path": "/path/to/connector/project",
    "file": "connector.rb"
  }
}

Detects a connector file and creates or updates .wisco.json.

If no path is provided, the current directory is used.

Examples:

bundle exec ruby wisco.rb init
bundle exec ruby wisco.rb init ./my-connector

Prints a tree view of the top-level connector structure.

Examples:

bundle exec ruby wisco.rb list
bundle exec ruby wisco.rb list ./my-connector

Prints actions as a markdown table.

bundle exec ruby wisco.rb list actions

Prints triggers as a markdown table.

bundle exec ruby wisco.rb list triggers

Prints the overview, actions, and triggers together.

bundle exec ruby wisco.rb list all

Runs connector execution flows.

Accepted path forms:

• actions.some_action
• triggers.some_trigger
• actions
• triggers
• some_action or some_trigger when the key is unique across sections

Use field mode to generate fixture files for a connector method:

bundle exec ruby wisco.rb exec actions.get_users --mode=fields

This creates files under fixtures/<section>/<key>/, including:

• input_fields.json
• output_fields.json
• execute_input.json

The generated execute_input.json starts with a sentinel comment so you can distinguish an untouched template from real input.

Use execute mode to run one or more prepared inputs:

bundle exec ruby wisco.rb exec actions.get_users --mode=execute
bundle exec ruby wisco.rb exec actions.get_users --mode=execute --input=execute_input.json

Outputs are written into the same fixture directory as:

• output_<input>.json
• error_<input>.txt when execution fails

• --mode=execute runs the action or trigger execution path
• --mode=fields fetches input and output field schemas
• --input=file.json selects a specific execute input file
• --overwrite=true overwrites a generated execute input template
• --debug prints execution details

Wisco uses .wisco.json in the target connector directory.

At minimum, it stores:

• connector.path
• connector.file

It may also contain connection data used during execution.

bundle exec ruby wisco.rb init
bundle exec ruby wisco.rb list all
bundle exec ruby wisco.rb exec actions.get_users --mode=fields
# edit fixtures/actions/get_users/execute_input.json
bundle exec ruby wisco.rb exec actions.get_users --mode=execute

wisco.rb
wisco.bat
lib/
  config.rb
  connector.rb
  commands/
    init.rb
    list.rb
    exec.rb
helpers/

• The project uses Workato::CLI::ExecCommand from the Workato Connector SDK.
• Connector files are evaluated locally to discover and load connector definitions.
• connector.rb is preferred during detection, but other .rb files in the target directory are also considered.