Skip to content

Commit 55af4ae

Browse files
gcclinuxgcclinux
committed
release 2.0.1 with numerous improvements
1 parent 00ce93d commit 55af4ae

7 files changed

Lines changed: 276 additions & 42 deletions

File tree

‎.github/FUNDING.yml‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# These are supported funding model platforms
2+
3+
github: gcclinux
4+
patreon: # Replace with a single Patreon username
5+
open_collective: # Replace with a single Open Collective username
6+
ko_fi: # Replace with a single Ko-fi username
7+
tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
8+
community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
9+
liberapay: # Replace with a single Liberapay username
10+
issuehunt: # Replace with a single IssueHunt username
11+
lfx_crowdfunding: # Replace with a single LFX Crowdfunding project-name e.g., cloud-foundry
12+
polar: # Replace with a single Polar username
13+
buy_me_a_coffee: gcclinux
14+
thanks_dev: # Replace with a single thanks.dev username
15+
custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']

‎.github/ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve
4+
title: ''
5+
labels: ''
6+
assignees: ''
7+
8+
---
9+
10+
**Describe the bug**
11+
A clear and concise description of what the bug is.
12+
13+
**To Reproduce**
14+
Steps to reproduce the behavior:
15+
1. Go to '...'
16+
2. Click on '....'
17+
3. Scroll down to '....'
18+
4. See error
19+
20+
**Expected behavior**
21+
A clear and concise description of what you expected to happen.
22+
23+
**Screenshots**
24+
If applicable, add screenshots to help explain your problem.
25+
26+
**Desktop (please complete the following information):**
27+
- OS: [e.g. iOS]
28+
- Browser [e.g. chrome, safari]
29+
- Version [e.g. 22]
30+
31+
**Smartphone (please complete the following information):**
32+
- Device: [e.g. iPhone6]
33+
- OS: [e.g. iOS8.1]
34+
- Browser [e.g. stock browser, safari]
35+
- Version [e.g. 22]
36+
37+
**Additional context**
38+
Add any other context about the problem here.

‎.github/ISSUE_TEMPLATE/feature_request.md‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for this project
4+
title: ''
5+
labels: ''
6+
assignees: ''
7+
8+
---
9+
10+
**Is your feature request related to a problem? Please describe.**
11+
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
12+
13+
**Describe the solution you'd like**
14+
A clear and concise description of what you want to happen.
15+
16+
**Describe alternatives you've considered**
17+
A clear and concise description of any alternative solutions or features you've considered.
18+
19+
**Additional context**
20+
Add any other context or screenshots about the feature request here.

‎.github/workflows/release.yml‎

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
name: Release
2+
3+
on:
4+
push:
5+
tags:
6+
- 'v*' # Push events to matching v*, i.e. v1.0, v20.15.10
7+
8+
jobs:
9+
build-and-release:
10+
runs-on: windows-latest
11+
permissions:
12+
contents: write # Needed for creating a release
13+
14+
steps:
15+
- name: Checkout code
16+
uses: actions/checkout@v4
17+
with:
18+
fetch-depth: 0 # Need full history for versioning/build number
19+
20+
- name: Set up Go
21+
uses: actions/setup-go@v5
22+
with:
23+
go-version: '1.23.x'
24+
25+
- name: Build all platforms
26+
run: .\build.ps1 all
27+
shell: pwsh
28+
29+
- name: List build artifacts
30+
run: Get-ChildItem -Path build -Recurse
31+
shell: pwsh
32+
33+
- name: Create Release
34+
uses: softprops/action-gh-release@v2
35+
with:
36+
files: |
37+
build/scmd-windows-amd64.exe
38+
build/scmd-linux-amd64
39+
build/scmd-linux-aarch64
40+
build/scmd-darwin-amd64
41+
build/scmd-darwin-arm64
42+
draft: false
43+
prerelease: false
44+
generate_release_notes: true
45+
tag_name: ${{ github.ref_name }}
46+
name: Release ${{ github.ref_name }}

‎CHANGELOG.md‎

Lines changed: 93 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,93 @@
1+
# Changelog
2+
3+
All notable changes to this project will be documented in this file.
4+
5+
## [2.0.1] - 2026-04-14
6+
7+
### Added
8+
- Several features added to interactive CLI
9+
- Enhanced natural language query support
10+
- Improved slash commands functionality
11+
12+
## [2.0.0] - 2026
13+
14+
### Changed
15+
- **BREAKING:** Migrated from SQLite (tardigrade.db) to PostgreSQL database
16+
- Complete database architecture overhaul
17+
- Improved performance and scalability
18+
19+
### Added
20+
- PostgreSQL integration with pgvector support
21+
- Environment-based configuration (.env file)
22+
- Migration guide documentation
23+
24+
## [1.3.8] - 2024-03-20
25+
26+
### Changed
27+
- Paused game development
28+
- Added favicon to web interface
29+
30+
## [1.3.7] - 2023-12-16
31+
32+
### Added
33+
- Started command game page feature
34+
35+
## [1.3.6] - 2023-09-09
36+
37+
### Added
38+
- `-block` flag to disable add commands page
39+
40+
## [1.3.5] - 2023-08-29
41+
42+
### Added
43+
- TLS capabilities for HTTPS support
44+
- SSL certificate configuration options
45+
46+
## [1.3.3] - 2023-04-05
47+
48+
### Changed
49+
- Minor cosmetics on help page
50+
51+
## [1.3.2] - 2023-04-01
52+
53+
### Added
54+
- Help page creation
55+
- Search login functionality
56+
57+
## [1.3.1] - 2023-03-26
58+
59+
### Added
60+
- Check if command already exists before adding
61+
- Cosmetic improvements
62+
63+
## [1.3.0] - 2023-03-19
64+
65+
### Added
66+
- Option to save or display functions
67+
68+
## [1.2.0] - 2023-03-12
69+
70+
### Added
71+
- Option to specify custom port for Web UI
72+
73+
## [1.1.0] - 2023-03-05
74+
75+
### Added
76+
- Binary upgrade option in the menu
77+
78+
## [1.0.2] - 2023-02-26
79+
80+
### Changed
81+
- Minor cosmetic changes in the search UI
82+
83+
## [1.0.1] - 2023-02-19
84+
85+
### Changed
86+
- Recompiled with updated tardigrade-mod v0.2.0
87+
88+
## [1.0.0] - 2023-02-18
89+
90+
### Added
91+
- Initial SCMD CLI release
92+
- Web UI interface
93+
- Basic command search and storage functionality

‎README.md‎

Lines changed: 64 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -18,11 +18,7 @@ Create a `.env` file in the project root with your PostgreSQL connection details
1818
Start an interactive session with natural language support:
1919

2020
```bash
21-
scmd.exe --interactive
22-
# or
23-
scmd.exe -i
24-
# or
25-
scmd.exe --cli
21+
scmd-windows-amd64.exe --cli
2622
```
2723

2824
**Features:**
@@ -32,50 +28,50 @@ scmd.exe --cli
3228
- User-friendly prompts and formatted output
3329

3430
### Example of the extended functions menu
35-
![SCMD v2.0.0 Interactive CLI](images/smcd-2.0.0-show.png)
31+
![CLI v2.0.0 Interactive CLI](images/smcd-2.0.0-show.png)
32+
---
33+
![WEB v2.0.1 Interactive CLI](images/smcd-2.0.1-web.png)
3634

3735
See [INTERACTIVE_MODE.md](INTERACTIVE_MODE.md) for detailed documentation.
3836

3937
### 2. Traditional CLI
4038

4139
**Search for commands:**
4240
```bash
43-
scmd.exe --search "postgresql replication"
44-
scmd.exe --search "docker,kubernetes"
41+
scmd-windows-amd64.exe --search "postgresql replication"
42+
scmd-windows-amd64.exe --search "docker,kubernetes"
4543
```
4644

4745
**Add new commands:**
4846
```bash
49-
scmd.exe --save "docker ps -a" "List all containers"
47+
scmd-windows-amd64.exe --save "docker ps -a" "List all containers"
5048
```
5149

5250
### 3. Web Interface
5351

5452
**Start web server:**
5553
```bash
56-
scmd.exe --web # Default port 3333
57-
scmd.exe --web -port 8080 # Custom port
58-
scmd.exe --web -block # Read-only mode
59-
scmd.exe --web -service # Background mode (no browser)
54+
scmd-windows-amd64.exe --web # Default port 3333
55+
scmd-windows-amd64.exe --web -port 8080 # Custom port
56+
scmd-windows-amd64.exe --web -block # Read-only mode
57+
scmd-windows-amd64.exe --web -service # Background mode (no browser)
6058
```
6159

62-
## Release History
60+
## Installation
61+
62+
### Download Pre-built Binaries
63+
64+
Download the latest release for your platform from the [GitHub Releases](https://github.com/gcclinux/scmd/releases) page:
65+
66+
- **Windows (AMD64):** `scmd-windows-amd64.exe`
67+
- **Linux (AMD64):** `scmd-linux-amd64`
68+
- **Linux (ARM64):** `scmd-linux-aarch64`
69+
- **macOS (Intel):** `scmd-darwin-amd64`
70+
- **macOS (Apple Silicon):** `scmd-darwin-arm64`
71+
72+
All binaries are ready to use - no compilation required!
6373

64-
Release: 1.0.0 - (18-02-2023) Initial SCMD CLI & Web UI<BR>
65-
Release: 1.0.1 - (19-02-2023) Recompiled with updated tardigrade-mod v0.2.0<BR>
66-
Release: 1.0.2 - (26-02-2023) Minor cosmetic changes in the search UI<BR>
67-
Release: 1.1.0 - (05-03-2023) Added binary upgrade option in the menu!<BR>
68-
Release: 1.2.0 - (12-03-2023) Added option to specific what port to open the Web UI<BR>
69-
Release: 1.3.0 - (19-03-2023) Added option to save or display functions also<BR>
70-
Release: 1.3.1 - (26-03-2023) Check if command already exist + cosmetics<BR>
71-
Release: 1.3.2 - (01-04-2023) Created the Help page and added search login.<BR>
72-
Release: 1.3.3 - (05-04-2023) Minor cosmetics on help page (before annual leave).<BR>
73-
Release: 1.3.5 - (29-08-2023) Added TLS capabilities for HTTPS.<BR>
74-
Release: 1.3.6 - (09-09-2023) Added -block "DISABLES" add commands page.<BR>
75-
Release: 1.3.7 - (16-12-2023) Started a command game page.<BR>
76-
Release: 1.3.8 - (20-03-2024) Pauzed game but added favicon.<BR>
77-
Release: 2.0.0 - (2026) **Migrated to PostgreSQL database**<BR>
78-
Release: 2.0.1 - (14-04-2026) **Several features added to interractive cli**<br>
74+
### Build from Source
7975

8076
> Display this help menu
8177
```
@@ -154,21 +150,47 @@ Usage: scmd-Linux-x86_64(exe) --search "patterns"
154150
Usage: scmd-Linux-x86_64(exe) --save "command" "description"
155151
```
156152

157-
Build and compile scmd from source code will require
158-
>go get github.com/lib/pq
159-
>go get github.com/joho/godotenv
153+
### Build from Source
160154

155+
Build and compile scmd from source code will require:
156+
- Go 1.23 or higher
157+
- Git
158+
- PostgreSQL database
161159

162-
\* Download and Install - https://go.dev/dl/ <BR>
163-
\* Download and Install - https://git-scm.com/downloads
164-
\* Setup PostgreSQL database and import data from tardigrade.db
160+
Dependencies:
161+
```bash
162+
go get github.com/lib/pq
163+
go get github.com/joho/godotenv
164+
```
165165

166+
Build steps:
167+
Build steps:
168+
169+
```bash
170+
git clone https://github.com/gcclinux/scmd.git
171+
cd scmd/
172+
cp .env.example .env
173+
# Edit .env with your PostgreSQL credentials
174+
go mod tidy
175+
go build -o scmd-$(uname)-$(uname -m) .
176+
scmd-$(uname)-$(uname -m) --help
166177
```
167-
$ git clone https://github.com/gcclinux/scmd.git
168-
$ cd scmd/
169-
$ cp .env.example .env
170-
$ # Edit .env with your PostgreSQL credentials
171-
$ go mod tidy
172-
$ go build -o scmd-$(uname)-$(uname -m) .
173-
$ scmd-$(uname)-$(uname -m) --help
178+
179+
Or use the build script:
180+
181+
**Windows:**
182+
```powershell
183+
.\build.ps1 all # Build for all platforms
184+
.\build.ps1 windows # Build for Windows only
185+
.\build.ps1 linux # Build for Linux only
186+
.\build.ps1 darwin # Build for macOS only
187+
```
188+
189+
**Linux/macOS:**
190+
```bash
191+
./compile.sh # Build for current platform
174192
```
193+
194+
## Release History
195+
196+
See [CHANGELOG.md](CHANGELOG.md) for detailed release history.

‎images/smcd-2.0.1-web.png‎

68.5 KB
Loading

0 commit comments

Comments
 (0)