Skip to content

docs: add CLI configuration details and fix CLI documentation navigation #2439

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Oct 24, 2025
Merged

docs: add CLI configuration details and fix CLI documentation navigation #2439

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
15a88ef
added configuration to cli docs and fix navigation for cli documentation
jatintalgotra-zd Oct 17, 2025
6803203
updated description for CMD_LOGS_FILE env
jatintalgotra-zd Oct 17, 2025
0a18028
Merge branch 'development' into fix/cli-docs-configs
coolwednesday Oct 17, 2025
232fedf
Merge branch 'development' into fix/cli-docs-configs
Umang01-hash Oct 24, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/navigation.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ export const navigation = [

{
title: 'CLI Applications',
href: '/docs/cli/cli',
href: '/docs/quick-start/cli',
desc: "Learn to build powerful command-line interface (CLI) applications using GoFr's app.NewCMD(), offering a robust framework for command-line tools."
},

Expand Down
7 changes: 6 additions & 1 deletion docs/cli/cli.md → docs/quick-start/cli/page.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,11 @@

GoFr provides a simple way to build command-line applications using `app.NewCMD()`. This creates standalone CLI tools without starting an HTTP server.

## Configuration
To configure logging for CLI applications, set the following environment variable:
- `CMD_LOGS_FILE`: The file path where CLI logs will be written. If not set, logs are discarded.


## Getting Started

Create a basic CLI application with subcommands:
Expand Down Expand Up @@ -71,4 +76,4 @@ go build -o mycli
./mycli --help
```

For more details, see the [sample-cmd example](../../examples/sample-cmd).
For more details, see the [sample-cmd example](../../../examples/sample-cmd).