Getting Started
- What is Flextype?
- Requirements
- Installation
- Configuration
- Folder Structure
- API Reference
- Code of Conduct
- Getting Help
- License
Core Concepts
Console
Rest API
Commands
Command | Description |
---|---|
entries:fetch | Fetch entry. |
entries:has | Check whether entry exists. |
entries:move | Move entry. |
entries:copy | Copy entry. |
entries:create | Create entry. |
entries:delete | Delete entry. |
entries:update | Update entry. |
Commands Details
entries:fetch
TERMINAL
bin/flextype entries:fetch -h
Description:
Fetch entry.
Usage:
entries:fetch [options] [--] [<id> [<options>]]
Arguments:
id Unique identifier of the entry.
options Options array.
Options:
--collection Set this flag to fetch entries collection.
--find-depth-from[=FIND-DEPTH-FROM] Restrict the entries files depth of traversing from.
--find-depth-to[=FIND-DEPTH-TO] Restrict the entries files depth of traversing to.
--find-date-from[=FIND-DATE-FROM] Restrict the entries files by a date range from.
--find-date-to[=FIND-DATE-TO] Restrict the entries filesby a date range to.
--find-size-from[=FIND-SIZE-FROM] Restrict the entries files by a size range from.
--find-size-to[=FIND-SIZE-TO] Restrict the entries files by a size range to.
--find-exclude[=FIND-EXCLUDE] Exclude directories from matching.
--find-contains[=FIND-CONTAINS] Find entries files by content.
--find-not-contains[=FIND-NOT-CONTAINS] Find entries files by content excludes files containing given pattern.
--find-path[=FIND-PATH] Find entries files and directories by path.
--find-sort-by-key[=FIND-SORT-BY-KEY] Sort the entries files and directories by the last accessed, changed or modified time. Values: atime, mtime, ctime.
--find-sort-by-direction[=FIND-SORT-BY-DIRECTION] Sort the entries files and directories by direction. Order direction: DESC (descending) or ASC (ascending)
--filter-return[=FILTER-RETURN] Return items. Valid values: all, first, last, next, random, shuffle
--filter-group-by[=FILTER-GROUP-BY] Group array collection by key.
--filter-offset[=FILTER-OFFSET] Extract a slice of the current array collection with specific offset.
--filter-limit[=FILTER-LIMIT] Extract a slice of the current array collection with offset 0 and specific length.
--filter-sort-by-key[=FILTER-SORT-BY-KEY] Sort array collection by key.
--filter-sort-by-direction[=FILTER-SORT-BY-DIRECTION] Sort array collection by direction. Order direction: DESC (descending) or ASC (ascending)
--filter-where[=FILTER-WHERE] Filters the array collection fields by a given condition. (multiple values allowed)
-h, --help Display help for the given command. When no command is given display help for the list command
-q, --quiet Do not output any message
-V, --version Display this application version
--ansi|--no-ansi Force (or disable --no-ansi) ANSI output
-n, --no-interaction Do not ask any interactive question
-v|vv|vvv, --verbose Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug
entries:has
TERMINAL
bin/flextype entries:has -h
Description:
Check whether entry exists.
Usage:
entries:has <id>
Arguments:
id Unique identifier of the entry.
Options:
-h, --help Display help for the given command. When no command is given display help for the list command
-q, --quiet Do not output any message
-V, --version Display this application version
--ansi|--no-ansi Force (or disable --no-ansi) ANSI output
-n, --no-interaction Do not ask any interactive question
-v|vv|vvv, --verbose Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug
entries:move
TERMINAL
bin/flextype entries:move -h
Description:
Move entry.
Usage:
entries:move <id> <newID>
Arguments:
id Unique identifier of the entry.
newID New Unique identifier of the entry
Options:
-h, --help Display help for the given command. When no command is given display help for the list command
-q, --quiet Do not output any message
-V, --version Display this application version
--ansi|--no-ansi Force (or disable --no-ansi) ANSI output
-n, --no-interaction Do not ask any interactive question
-v|vv|vvv, --verbose Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug
entries:copy
TERMINAL
bin/flextype entries:copy -h
Description:
Copy entry.
Usage:
entries:copy <id> <newID>
Arguments:
id Unique identifier of the entry.
newID New Unique identifier of the entry
Options:
-h, --help Display help for the given command. When no command is given display help for the list command
-q, --quiet Do not output any message
-V, --version Display this application version
--ansi|--no-ansi Force (or disable --no-ansi) ANSI output
-n, --no-interaction Do not ask any interactive question
-v|vv|vvv, --verbose Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug
entries:create
TERMINAL
bin/flextype entries:create -h
Description:
Create entry.
Usage:
entries:create <id> [<data>]
Arguments:
id Unique identifier of the entry.
data Data to create for the entry.
Options:
-h, --help Display help for the given command. When no command is given display help for the list command
-q, --quiet Do not output any message
-V, --version Display this application version
--ansi|--no-ansi Force (or disable --no-ansi) ANSI output
-n, --no-interaction Do not ask any interactive question
-v|vv|vvv, --verbose Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug
entries:delete
TERMINAL
bin/flextype entries:delete -h
Description:
Delete entry.
Usage:
entries:delete <id>
Arguments:
id Unique identifier of the entry.
Options:
-h, --help Display help for the given command. When no command is given display help for the list command
-q, --quiet Do not output any message
-V, --version Display this application version
--ansi|--no-ansi Force (or disable --no-ansi) ANSI output
-n, --no-interaction Do not ask any interactive question
-v|vv|vvv, --verbose Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug
entries:update
TERMINAL
bin/flextype entries:update -h
Description:
Update entry.
Usage:
entries:update <id> [<data>]
Arguments:
id Unique identifier of the entry.
data Data to update for the entry.
Options:
-h, --help Display help for the given command. When no command is given display help for the list command
-q, --quiet Do not output any message
-V, --version Display this application version
--ansi|--no-ansi Force (or disable --no-ansi) ANSI output
-n, --no-interaction Do not ask any interactive question
-v|vv|vvv, --verbose Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug