Skip to content

commit: update wheels cli docs - updating outputs of commands #1850

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
zainforbjs merged 2 commits into from
Jan 28, 2026
Merged

commit: update wheels cli docs - updating outputs of commands #1850

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
12fe9d3
commit: update wheels cli docs - updating outputs of commands
zainforbjs Jan 27, 2026
8b1988e
commit: update cli docs fixes
zainforbjs Jan 28, 2026
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
4 changes: 2 additions & 2 deletions cli/src/commands/wheels/init.cfc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ component extends="base" {

// Create a server.json if one doesn't exist
if(!fileExists(serverJsonLocation)){
var appName = ask( message = "Please enter an application name: we use this to make the server.json servername unique: ", defaultResponse = 'myapp');
var appName = ask( message = "Please enter an application name (we use this to make the server.json servername unique): ", defaultResponse = 'myapp');
appName = helpers.stripSpecialChars(appName);
var setEngine = ask( message = 'Please enter a default cfengine: ', defaultResponse = 'lucee@6' );

Expand All @@ -84,7 +84,7 @@ component extends="base" {
// Create a box.json if one doesn't exist
if(!fileExists(boxJsonLocation)){
if(!isDefined("appName")) {
var appName = ask("Please enter an application name: we use this to make the box.json servername unique: ");
var appName = ask("Please enter an application name (we use this to make the box.json servername unique): ");
appName = helpers.stripSpecialChars(appName);
}
var boxJSON = fileRead( getTemplate('/BoxJSON.txt' ) );
Expand Down
52 changes: 51 additions & 1 deletion docs/src/command-line-tools/commands/analysis/analyze-code.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -132,7 +132,55 @@ wheels analyze code --path=app/models --fix --report --verbose

### Console Output (Default)
```
Analyzing code quality...
Analyzing code quality with report and verbose output...

Configuration:
Path: C:\Users\Hp\db_app\app\models\
Severity filter: warning
Fix mode: enabled
Output format: console
Report generation: enabled

Scanning for files... + C:\Users\Hp\db_app\app\models\Model.cfc
Found 1 files to analyze
Analyzing file 1/1: C:\Users\Hp\db_app\app\models\Model.cfc
File has 7 lines
Running code style checks...
Running security checks...
Running performance checks...
Running best practice checks...
Running complexity analysis...
Checking naming conventions...
Detecting code smells...
Checking for deprecated functions...
Checking Wheels conventions...
Found 0 issues total, 0 after severity filter
Analyzing: [==================================================] 100% Complete!
Starting duplicate code detection...
Detecting duplicate code... Found 0 duplicate blocks

Applying automatic fixes...
Fixed 0 issues automatically

Re-analyzing after fixes with verbose output...
Scanning for files... + C:\Users\Hp\db_app\app\models\Model.cfc
Found 1 files to analyze
Analyzing file 1/1: C:\Users\Hp\db_app\app\models\Model.cfc
File has 7 lines
Running code style checks...
Running security checks...
Running performance checks...
Running best practice checks...
Running complexity analysis...
Checking naming conventions...
Detecting code smells...
Checking for deprecated functions...
Checking Wheels conventions...
Found 0 issues total, 0 after severity filter
Analyzing: [==================================================] 100% Complete!
Starting duplicate code detection...
Detecting duplicate code... Found 0 duplicate blocks


Scanning for files... Found 51 files to analyze
Analyzing: [==================================================] 100% Complete!
Expand Down Expand Up @@ -160,6 +208,8 @@ Deprecated Calls: 0

Grade: A (100/100)
Excellent! No issues found. Your code is pristine!
Generating HTML report...
HTML report generated: C:\Users\Hp\db_app\reports\code-analysis .....html
```

### JSON Output
Expand Down
2 changes: 1 addition & 1 deletion docs/src/command-line-tools/commands/analysis/analyze-performance.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,7 @@ Target: all
Threshold: 100ms

[====================] 100% Complete!

Profiling mode disabled
==================================================
PERFORMANCE ANALYSIS COMPLETE
==================================================
Expand Down
11 changes: 5 additions & 6 deletions docs/src/command-line-tools/commands/application-utilities/about.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,12 +26,11 @@ wheels about

Output:
```
_____ _______ ___ _
/ ____| ____\ \ / / | | |
| | | |__ \ \ /\ / /| |__ ___ ___| |___
| | | __| \ \/ \/ / | '_ \ / _ \/ _ \ / __|
| |____| | \ /\ / | | | | __/ __/ \__ \
\_____|_| \/ \/ |_| |_|\___|\___|_|___/
\ \ / / | | |
\ \ /\ / /| |__ ___ ___| |___
\ \/ \/ / | '_ \ / _ \/ _ \ / __|
\ /\ / | | | | __/ __/ \__ \
\/ \/ |_| |_|\___|\___|_|___/

Wheels Framework
Version: 2.5.0
Expand Down
114 changes: 58 additions & 56 deletions docs/src/command-line-tools/commands/config/config-diff.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -109,11 +109,13 @@ project_root/
The table output is organized into clear sections:

```
========================================
==================================================
Configuration Comparison: development vs production
========================================
==================================================

[SETTINGS CONFIGURATION]

ENVIRONMENT VARIABLES
--------------------------------------------------

Different Values:
┌──────────────────────┬────────────┬────────────┐
Expand Down Expand Up @@ -147,72 +149,72 @@ Different Values:
│ DEBUG_MODE │ true │ false │
└──────────────┴────────────────┴────────────────┘

========================================
SUMMARY
========================================
==================================================
SUMMARY
==================================================
Settings:
Total: 25
Identical: 20
Different: 2
Unique: 3
Total: 25
Identical: 20
Different: 2
Unique: 3

Environment Variables:
Total: 15
Identical: 10
Different: 2
Unique: 3
Total: 15
Identical: 10
Different: 2
Unique: 3

Overall:
Total configurations: 40
Identical: 30
Different: 4
Unique: 6
Similarity: 75%
Total configurations: 40
Identical: 30
Different: 4
Unique: 6
Similarity: 75%
```

### JSON Format

```json
{
"env1": "development",
"env2": "production",
"comparisons": {
"settings": {
"identical": [...],
"different": [...],
"onlyInFirst": [...],
"onlyInSecond": [...]
},
"env": {
"identical": [...],
"different": [...],
"onlyInFirst": [...],
"onlyInSecond": [...]
}
},
"summary": {
"settings": {
"totalSettings": 25,
"identical": 20,
"different": 2,
"onlyInFirst": 1,
"onlyInSecond": 2
},
"env": {
"totalVariables": 15,
"identical": 10,
"different": 2,
"onlyInFirst": 1,
"onlyInSecond": 2
"ENV1": "development",
"ENV2": "production",
"COMPARISONS":{
"SETTINGS":{
"IDENTICAL":[...],
"DIFFERENT":[...],
"ONLYINSECOND":[...],
"ONLYINFIRST":[...]
},
"ENV": {
"ONLYINSECOND":[...],
"DIFFERENT":[...],
"IDENTICAL":[...],
"ONLYINFIRST":[...]
}
},
"overall": {
"total": 40,
"identical": 30,
"different": 4,
"unique": 6,
"similarity": 75
"SUMMARY": {
"ENV":{
"TOTALVARIABLES":12,
"ONLYINSECOND":1,
"DIFFERENT":0,
"IDENTICAL":0,
"ONLYINFIRST":11
},
"OVERALL":{
"UNIQUE":12,
"SIMILARITY":14,
"DIFFERENT":0,
"TOTAL":14,
"IDENTICAL":2
},
"SETTINGS":{
"ONLYINSECOND":0,
"TOTALSETTINGS":2,
"DIFFERENT":0,
"IDENTICAL":2,
"ONLYINFIRST":0
}
}
}
}
```

Expand Down
16 changes: 14 additions & 2 deletions docs/src/command-line-tools/commands/core/deps.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -126,18 +126,27 @@ The report includes:

Example output:
```
Dependency Report:
==================================================
Wheels Dependency Manager
==================================================

Generating dependency report...
==================================================
Dependency Report
==================================================

Generated: 2025-09-19 11:38:44
Wheels Version: 3.0.0-SNAPSHOT
CFML Engine: Lucee 5.4.6.9

Dependencies:
--------------------------------------------------
cbvalidation @ ^4.6.0+28 - Installed: No
shortcodes @ ^0.0.4 - Installed: No
wirebox @ ^7.4.2+24 - Installed: No

Dev Dependencies:
--------------------------------------------------
testbox @ ^6.4.0+17 - Installed: Yes

Checking for outdated packages...
Expand All @@ -147,9 +156,12 @@ Checking for outdated packages...
│ testbox@^6.4.. │ 6.4.0+17 │ 6.4.0+17 │ 6.4.0+17 │ /testbox │
└────────────────┴───────────┴──────────┴──────────┴─────────────────────┘

Checking for outdated packages...

Checking for outdated dependencies, please wait...
There are no outdated dependencies!

Full report exported to: dependency-report-20250919-113851.json
[SUCCESS]: Full report exported to: dependency-report-20250919-113851.json
```

## Integration with CommandBox
Expand Down
6 changes: 3 additions & 3 deletions docs/src/command-line-tools/commands/core/destroy.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,9 +71,9 @@ wheels d user

This will prompt this along with a confirmation:
```
================================================
= Watch Out! =
================================================
==================================================
Watch Out!
==================================================
This will delete the associated database table 'users', and
the following files and directories:

Expand Down
8 changes: 5 additions & 3 deletions docs/src/command-line-tools/commands/core/init.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,9 @@ wheels init

Example interaction:
```
==================================== Wheels init ===================================
==================================================
Wheels init
==================================================
This function will attempt to add a few things
to an EXISTING Wheels installation to help
the CLI interact.
Expand All @@ -50,10 +52,10 @@ Example interaction:
We're going to try and do the following:
- create a box.json to help keep track of the wheels version
- create a server.json
====================================================================================
--------------------------------------------------

Sound ok? [y/n] y
Please enter an application name: myapp
Please enter an application name (we use this to make the server.json servername unique): myapp
Please enter a default cfengine: lucee5
```

Expand Down
Loading
Loading