common-workflow-language / common-workflow-language/cwl-v1.3

shellCommand

Open
#44 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Common Workflow Language
Stars
6
Forks
4
PR merge metrics
No merged PRs in 30d

Description

Split out from #33 because it is a bit more complicated.

ShellCommandRequirement

Becomes "shellCommand" on CommandLineTool with value 'true' or 'false' (default is 'false') but with different semantics than "ShellCommandRequirement".

Having "shellCommand: true" (or "useShell: true" or whatever we call it) specifies semantics so that

  • it is run with /bin/sh -c
  • the command line is constructed such that each component is added to the command line separated by spaces and but any parameter substitutions are quoted. Quoting parameter substitutions can be suppressed using 'shellQuote: false', but I think in most cases this won't be necessary (and presents the opportunity for shell injection, so it should be strongly discouraged).

This differs from ShellCommandRequirement where each element of the command line is quoted by default unless 'shellQuote: false' is present, which makes it very awkward to use shell metacharacters even when it is safe to do so.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

No files or tests are named. Start by locating the CommandLineTool and ShellCommandRequirement definitions, then compare their documented semantics; done means the proposed shellCommand behavior, defaults, quoting rules, and /bin/sh -c execution are specified and covered by the project’s relevant validation.

Written by the indexing model from the issue text.

Assessment

Tech stack
shell
Domain
cli
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.