io7m | single-page | multi-page | Cardant User Manual 1.0.0-SNAPSHOT
7.2.13. files-recent
Previous
7.2. Shell Command Reference
Up
7.2.15. item-attachment-add
Next

# 7.2.14. help

- 7.2.14.1. Name
- 7.2.14.2. Description
- 7.2.14.3. Examples

## 7.2.14.1. Name

1
help - Display help for a given command.

## 7.2.14.2. Description

1
The help command displays help for the given command.

## 7.2.14.3. Examples

### 7.2.14.3.1. Example

    [cardant]$ help file-put
    cardant: usage: file-put [named-arguments ...]

      Upload a file.

      Named parameters:
        --content-type
          Description       : The content type (inferred if not specified).
          Type              : String
          Cardinality       : [0, 1]; Specify at most once.
          Syntax            : <any sequence of characters>
        --description
          Description       : The file description.
          Type              : String
          Cardinality       : [0, 1]; Specify at most once.
          Syntax            : <any sequence of characters>
      * --file
          Description       : The file.
          Type              : Path
          Cardinality       : [1]; Specify exactly once.
          Syntax            : <platform-specific path syntax>
      * --id
          Description       : The file ID.
          Type              : CAFileID
          Cardinality       : [1]; Specify exactly once.
          Syntax            : [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}

      The command does not accept any positional arguments.

7.2.13. files-recent
Previous
7.2. Shell Command Reference
Up
7.2.15. item-attachment-add
Next
io7m | single-page | multi-page | Cardant User Manual 1.0.0-SNAPSHOT