Skip to content

feat: documentation for console arguments - #132

Merged
hwbrzzl merged 2 commits into
goravel:v1.17.xfrom
oprudkyi:issue/cli_arguments
Oct 25, 2025
Merged

feat: documentation for console arguments#132
hwbrzzl merged 2 commits into
goravel:v1.17.xfrom
oprudkyi:issue/cli_arguments

Conversation

@oprudkyi

@oprudkyi oprudkyi commented Sep 26, 2025

Copy link
Copy Markdown
Contributor

📑 Description

documentation for console arguments goravel/framework#1199

@hwbrzzl hwbrzzl left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, could you modify the base branch to v1.17.x?


Supported agrument types : `ArgumentFloat32`, `ArgumentFloat64`, `ArgumentInt`, `ArgumentInt8`, `ArgumentInt16`, `ArgumentInt32`, `ArgumentInt64`, `ArgumentString`, `ArgumentUint`, `ArgumentUint8`, `ArgumentUint16`, `ArgumentUint32`, `ArgumentUint64`, `ArgumentTimestamp`, `ArgumentFloat32Slice`, `ArgumentFloat64Slice`, `ArgumentIntSlice`, `ArgumentInt8Slice`, `ArgumentInt16Slice`, `ArgumentInt32Slice`, `ArgumentInt64Slice`, `ArgumentStringSlice`, `ArgumentUintSlice`, `ArgumentUint8Slice`, `ArgumentUint16Slice`, `ArgumentUint32Slice`, `ArgumentUint64Slice`, `ArgumentTimestampSlice`

Argument types with single value support next fields:

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Argument types with single value support next fields:
Argument types with single value support next fields:

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

updated

Usage string // the usage text to show
Required bool // if this argument is required
```
Slice argument types fields:

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Slice argument types fields:
Slice argument types fields:

Min int // the min num of occurrences of this argument
Max int // the max num of occurrences of this argument, set to -1 for unlimited
```
Timestamp arguments additionally supports `Layouts []string` field, that should be filled with [supported layouts](https://pkg.go.dev/time#pkg-constants)

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Timestamp arguments additionally supports `Layouts []string` field, that should be filled with [supported layouts](https://pkg.go.dev/time#pkg-constants)
Timestamp arguments additionally supports `Layouts []string` field, that should be filled with [supported layouts](https://pkg.go.dev/time#pkg-constants)

@oprudkyi
oprudkyi changed the base branch from master to v1.17.x September 30, 2025 03:28
@oprudkyi

Copy link
Copy Markdown
Contributor Author

Hi @hwbrzzl
I have added new lines and re-based onto v1.17.x

@hwbrzzl hwbrzzl left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great 👍

@hwbrzzl
hwbrzzl merged commit 4859393 into goravel:v1.17.x Oct 25, 2025
hwbrzzl pushed a commit that referenced this pull request Jan 16, 2026
* feat: documentation for console arguments

* fix: text formatting
hwbrzzl added a commit that referenced this pull request Jan 31, 2026
* optimize mockery

* add divider and colored outputs (#137)

* Add MongoDB package (#140)

* add mongodb package

* Update packages.md with test coverage note

Added a note about test coverage ordering and corrected a missing asterisk in the table header.

* Enhance package.md with discoverability tips via GitHub Topic (#141)

* Enhance package.md with discoverability tips

Added tips for improving package discoverability in the documentation.

* Add goravel topic

* Enhance topic addition instructions in packages.md

Updated instructions for adding topics to a repository for better discoverability.

* Clean up blank lines in packages.md

Removed extra blank lines in the packages documentation.

* feat: documentation for console arguments (#132)

* feat: documentation for console arguments

* fix: text formatting

* feat: [#559] Feature Comparison Table with Laravel

* optimize

* add introduction to process facade

* add docs for process Pipelining

* add warning in process Pipeline configuration

* add doc for async processes

* add doc for concurrent processes

* add docs for pluralization

* add pluralization supported languages

* optimize mockery

* add divider and colored outputs (#137)

* Add MongoDB package (#140)

* add mongodb package

* Update packages.md with test coverage note

Added a note about test coverage ordering and corrected a missing asterisk in the table header.

* Enhance package.md with discoverability tips via GitHub Topic (#141)

* Enhance package.md with discoverability tips

Added tips for improving package discoverability in the documentation.

* Add goravel topic

* Enhance topic addition instructions in packages.md

Updated instructions for adding topics to a repository for better discoverability.

* Clean up blank lines in packages.md

Removed extra blank lines in the packages documentation.

* feat: documentation for console arguments (#132)

* feat: documentation for console arguments

* fix: text formatting

* feat: [#559] Feature Comparison Table with Laravel

* optimize

* add introduction to process facade

* add docs for process Pipelining

* add warning in process Pipeline configuration

* add doc for async processes

* add doc for concurrent processes

* add docs for pluralization

* add pluralization supported languages

* mail template

* optimize

* add some features

* optimize

* optimize

* optimize

* optimize

* optimize

* optimize

* remove telemetry facade documentation

* optimise pluralization example

* add documentation for http client testing

* fix view.md

* optimize

* optimize TODO

* add navigate

* add versions

* add versions

* optimize home page

* optimize code

* add new providers

* optimize grpc

---------

Co-authored-by: zoryamba <zoryamba@gmail.com>
Co-authored-by: toni dy <tonidy@users.noreply.github.com>
Co-authored-by: Oleksii Prudkyi <oprudkyi@users.noreply.github.com>
Co-authored-by: krishan kumar <84431594+kkumar-gcc@users.noreply.github.com>
Co-authored-by: kkumar-gcc <krishkumar9352@gmail.com>
Co-authored-by: krishan kumar <84431594+krishankumar01@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants