Skip to content

Latest commit

 

History

History
115 lines (78 loc) · 2.9 KB

command_docs_template.md

File metadata and controls

115 lines (78 loc) · 2.9 KB
title description
<CMD NAME HERE>
description here in 2 to 3 lines

Syntax

# command syntax here

Parameters

Parameter Description Type Required

Return values

Condition Return Value

Behaviour

  • Bullet 1
  • Bullet 2
  • Bullet 3

Errors

  1. Wrong type of value or key:

    • Error Message: (error) WRONGTYPE Operation against a key holding the wrong kind of value
    • Occurs when attempting to use the command on a key that contains a non-string value.

Example Usage

Basic Usage

127.0.0.1:7379> SET foo bar
OK

Invalid usage

127.0.0.1:7379> <CMD syntax here>
(error) ERR syntax error

Best Practices

Alternatives

Notes

Subcommands

  • subcommand: Optional. Available subcommands include:
    • subcommand1 : some description of the subcommand.