package shellwords

Some checked builds fail
  1. Overview
  2. Docs
POSIX shell command word parsing and quoting utilities

Install 

dune-project
 Dependency

codeberg.org Readme Edit opam file Versions (1)

Authors

  1. D
    Daniel Fichtinger <daniel@ficd.sh>

Maintainers

  1. D
    Daniel Fichtinger <daniel@ficd.sh>

Sources

1.0.0.tar.gz
md5=be880543665890bd93c725910b01409c
sha512=571ad03aef4fdbd88ed05b9c18c92cc33412971f93b51c732f8c83f2bcda3bb116f07715c74403a0366d0258fa0478bc0d502543e71a23454f2722b4aec0d86f

Description

Shellwords is an OCaml implementation of POSIX shell word parsing, intended to match the behavior of the Rust shell-words crate. The library follows the parsing rules of the POSIX.1-2008 Shell Command Language, including quoting, escaping, line continuations, and comments, while delberately excluding shell expansions such as globbing, variable substitution, command substitution, and arithmetic expansion. The API is designed for argv-style processing and provides functionality such as splitting command strings into words and producing shell-safe representations of arguments. Behavioral compatibility with the Rust shell-words crate is a primary goal.

Tags

shell shellwords posix parsing command-line argv quoting splitting string

Added to opam-repository:

README

shellwords library

The goal of this library is to provide identical behavior to Rust's shell-words crate. That is, in accordance with the parsing rules of Unix shell as specified in Shell Command Language in POSIX.1-2008

Implemented Functions

  • join: string list -> string
  • quote: string -> string
  • split: string -> string list

Dependencies (2)

  1. ocaml
  2. dune >= "3.20"

Dev Dependencies (2)

  1. odoc with-doc
  2. ounit2 with-test

Optional Dependencies

None

Used by

None

Conflicts

None

Build status

Results of building shellwords with each compiler on check.ci.ocaml.org, run of against opam-repository 8a77e58. All results for this package.

Each result links to its build log. To keep crawlers from overloading the site, build logs require a GitHub sign-in (see ocurrent/opam-health-check). On your first log, GitHub asks you to “Authorize opam-health-check”, the OCurrent app that runs these checks; it sees only your public profile, not your repositories. The sign-in lasts 30 days.

Version OCaml 4.11 OCaml 4.14 OCaml 5.2 OCaml 5.4 OCaml 5.5
1.0.0 (this version) good internal internal good internal
  • good Package successfully built
  • partial One of the dependencies failed to build
  • bad Package failed to build
  • n/a Package is not available in this environment
  • internal Internal failure