COMMAND LIST

Syntax text Syntax diagram API methods

COMMAND LIST [FILTERBY <MODULE module-name | ACLCAT category |
  PATTERN pattern>]

Client:

command_list(
    module: str | None,
    category: str | None,
    pattern: str | None,
    **kwargs: Any
) → list

Possible errors

ERR syntax error: ResponseError

See Redis error messages for what each error means. Other errors, such as connection errors, aren't listed.

commandList(
    options: CommandListOptions
) → ArrayReply<BlobStringReply>

Possible errors

ERR syntax error: SimpleError

See Redis error messages for what each error means. Other errors, such as connection errors, aren't listed.

command(
    subcommand: "LIST",
    callback?: Callback<unknown[]>
) → Result<unknown[], Context>

command(
    subcommand: "LIST",
    filterby: "FILTERBY",
    moduleNameToken: "MODULE",
    moduleName: string | Buffer,
    callback?: Callback<unknown[]>
) → Result<unknown[], Context>

command(
    subcommand: "LIST",
    filterby: "FILTERBY",
    categoryToken: "ACLCAT",
    category: string | Buffer,
    callback?: Callback<unknown[]>
) → Result<unknown[], Context>

command(
    subcommand: "LIST",
    filterby: "FILTERBY",
    patternToken: "PATTERN",
    pattern: string,
    callback?: Callback<unknown[]>
) → Result<unknown[], Context>

Possible errors

ERR syntax error: ReplyError

See Redis error messages for what each error means. Other errors, such as connection errors, aren't listed.

commandList() → List<String>

commandList(
    filterBy: CommandListFilterBy
) → List<String>

Possible errors

ERR syntax error: JedisDataException

See Redis error messages for what each error means. Other errors, such as connection errors, aren't listed.

CommandList(
    ctx: context.Context,  // Context
    filter: *FilterBy
) → *StringSliceCmd

Possible errors

ERR syntax error: redis.Error

See Redis error messages for what each error means. Other errors, such as connection errors, aren't listed.

CommandList(
    moduleName: RedisValue?,  // The module name to filter the command list by.
    category: RedisValue?,  // The category to filter the command list by.
    pattern: RedisValue?,  // The pattern to filter the command list by.
    flags: CommandFlags  // The command flags to use.
) → string[]

Possible errors

ERR syntax error: RedisServerException

See Redis error messages for what each error means. Other errors, such as connection errors, aren't listed.

CommandListAsync(
    moduleName: RedisValue?,  // The module name to filter the command list by.
    category: RedisValue?,  // The category to filter the command list by.
    pattern: RedisValue?,  // The pattern to filter the command list by.
    flags: CommandFlags  // The command flags to use.
) → Task<string[]>

Possible errors

ERR syntax error: RedisServerException

See Redis error messages for what each error means. Other errors, such as connection errors, aren't listed.

command(
    $subcommand: string,
    $argument: mixed
) → array

Possible errors

ERR syntax error: Predis\Response\ServerException

See Redis error messages for what each error means. Other errors, such as connection errors, aren't listed.

Available since:: Redis Open Source 7.0.0
Time complexity:: O(N) where N is the total number of Redis commands
ACL categories:: @slow, @connection,
Compatibility:: Redis Software and Redis Cloud compatibility

Return an array of the Redis server's command names.

Optional arguments

FILTERBY MODULE module-name | ACLCAT category | PATTERN pattern

Filter the listed commands by module (MODULE), ACL category (ACLCAT), or a glob-style name pattern (PATTERN).

Redis Software and Redis Cloud compatibility

Redis Software	Redis Cloud	Notes
✅ Standard ✅ Active-Active	✅ Standard ✅ Active-Active

Return information

RESP2 RESP3

Array reply: a list of command names.

	Products	Version
	Develop with Redis Clients, data types, programmability, and Redis for AI. RedisVL is listed separately.
	Libraries and tools Client libraries, observability, and cloud integrations. Redis Data Integration is listed separately.
	RedisVL
	Redis Software
	Redis Cloud
	Redis for Kubernetes
	Redis Open Source
	Redis Iris context engine
	Redis Feature Form
	Redis Insight
	Redis Data Integration
	Glossary
	Command reference