Skip to content

Commit 775ce70

Browse files
committed
Fix badges
1 parent 775b188 commit 775ce70

7 files changed

Lines changed: 49 additions & 109 deletions

File tree

.github/workflows/api-ci.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ jobs:
8181
id: meta
8282
uses: docker/metadata-action@v5
8383
with:
84-
images: ghcr.io/jfmlima/shelly-manager/api
84+
images: ghcr.io/jfmlima/shelly-manager-api
8585
tags: |
8686
type=ref,event=branch
8787
type=ref,event=pr

.github/workflows/cli-ci.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ jobs:
8181
id: meta
8282
uses: docker/metadata-action@v5
8383
with:
84-
images: ghcr.io/jfmlima/shelly-manager/cli
84+
images: ghcr.io/jfmlima/shelly-manager-cli
8585
tags: |
8686
type=ref,event=branch
8787
type=ref,event=pr

.github/workflows/release.yml

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -27,21 +27,21 @@ jobs:
2727
## Docker Images
2828
2929
🐳 **Available Docker Images:**
30-
- `${{ env.IMAGE_PREFIX }}/api:${{ github.ref_name }}`
31-
- `${{ env.IMAGE_PREFIX }}/cli:${{ github.ref_name }}`
32-
- `${{ env.IMAGE_PREFIX }}/web:${{ github.ref_name }}`
30+
- `${{ env.IMAGE_PREFIX }}-api:${{ github.ref_name }}`
31+
- `${{ env.IMAGE_PREFIX }}-cli:${{ github.ref_name }}`
32+
- `${{ env.IMAGE_PREFIX }}-web:${{ github.ref_name }}`
3333
3434
## Quick Start
3535
3636
```bash
3737
# Run API server
38-
docker run -p 8000:8000 ${{ env.IMAGE_PREFIX }}/api:${{ github.ref_name }}
38+
docker run -p 8000:8000 ${{ env.IMAGE_PREFIX }}-api:${{ github.ref_name }}
3939
4040
# Run CLI tool
41-
docker run --rm ${{ env.IMAGE_PREFIX }}/cli:${{ github.ref_name }} --help
41+
docker run --rm ${{ env.IMAGE_PREFIX }}-cli:${{ github.ref_name }} --help
4242
4343
# Run Web UI
44-
docker run -p 8080:8080 ${{ env.IMAGE_PREFIX }}/web:${{ github.ref_name }}
44+
docker run -p 8080:8080 ${{ env.IMAGE_PREFIX }}-web:${{ github.ref_name }}
4545
```
4646
4747
## Changes
@@ -83,7 +83,7 @@ jobs:
8383
id: meta
8484
uses: docker/metadata-action@v5
8585
with:
86-
images: ${{ env.IMAGE_PREFIX }}/${{ matrix.package.name }}
86+
images: ${{ env.IMAGE_PREFIX }}-${{ matrix.package.name }}
8787
tags: |
8888
type=semver,pattern={{version}}
8989
type=semver,pattern={{major}}.{{minor}}

.github/workflows/web-ci.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ jobs:
6262
id: meta
6363
uses: docker/metadata-action@v5
6464
with:
65-
images: ghcr.io/jfmlima/shelly-manager/web
65+
images: ghcr.io/jfmlima/shelly-manager-web
6666
tags: |
6767
type=ref,event=branch
6868
type=ref,event=pr

README.md

Lines changed: 28 additions & 88 deletions
Original file line numberDiff line numberDiff line change
@@ -1,69 +1,39 @@
1-
# 🏠 Shelly Manager
1+
# Shelly Manager
22

3-
**Local management and automation for Shelly IoT devices**
3+
Local management for Shelly IoT devices without cloud connectivity.
44

55
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
66
[![GitHub release](https://img.shields.io/github/release/jfmlima/shelly-manager.svg)](https://github.com/jfmlima/shelly-manager/releases)
7-
[![Docker Pulls](https://img.shields.io/docker/pulls/ghcr.io/jfmlima/shelly-manager/api)](https://github.com/jfmlima/shelly-manager/pkgs/container/shelly-manager%2Fapi)
7+
[![API Pulls](https://img.shields.io/docker/pulls/ghcr.io/jfmlima/shelly-manager-api)](https://github.com/jfmlima/shelly-manager/pkgs/container/shelly-manager-api)
8+
[![CLI Pulls](https://img.shields.io/docker/pulls/ghcr.io/jfmlima/shelly-manager-cli)](https://github.com/jfmlima/shelly-manager/pkgs/container/shelly-manager-cli)
9+
[![Web Pulls](https://img.shields.io/docker/pulls/ghcr.io/jfmlima/shelly-manager-web)](https://github.com/jfmlima/shelly-manager/pkgs/container/shelly-manager-web)
810

9-
Shelly Manager is a comprehensive, **privacy-first** solution for managing Shelly IoT devices locally on your network. No cloud dependency, no data sharing - just powerful local control over your smart home devices.
11+
Manage Shelly devices on your local network without connecting them to the Shelly Cloud. Scan for devices, update firmware, manage configurations, and monitor status - all locally.
1012

11-
## ✨ Why Shelly Manager?
13+
## Features
1214

13-
- **🔒 Privacy First**: All operations happen locally - no cloud required
14-
- **🚀 Professional Grade**: Enterprise-ready architecture with comprehensive testing
15-
- **🎯 Shelly Specialized**: Deep integration with Shelly device features and protocols
16-
- **🔧 Multiple Interfaces**: Web UI for management, CLI for automation, REST API for integration
17-
- **📦 Easy Deployment**: Docker containers for quick setup and scalability
18-
19-
## 🎯 Key Features
20-
21-
### 🔍 **Device Discovery & Management**
22-
23-
- Network scanning with IP ranges and CIDR notation
24-
- Automatic device detection and status monitoring
15+
- Device discovery by network scanning
16+
- Firmware update management (stable/beta channels)
17+
- Device configuration changes
2518
- Bulk operations across multiple devices
26-
- Configuration-based device organization
27-
28-
### 🔄 **Firmware Management**
29-
30-
- Automated firmware update checking
31-
- Safe firmware updates with rollback protection
32-
- Channel selection (stable/beta)
33-
- Update progress monitoring
34-
35-
### ⚙️ **Configuration Management**
19+
- Status monitoring
3620

37-
- Complete device configuration control
38-
- JSON-based configuration templates
39-
- Bulk configuration deployment
40-
- Configuration backup and restore
21+
Available as:
4122

42-
### 📊 **Rich Interfaces**
23+
- Web interface
24+
- Command line tool
25+
- REST API
4326

44-
- **Web UI**: Modern, responsive interface for device management
45-
- **CLI Tool**: Powerful command-line interface for automation and scripting
46-
- **REST API**: Full-featured API for custom integrations
27+
## Quick Start
4728

48-
### 🏗️ **Enterprise Architecture**
29+
### Docker
4930

50-
- Clean Architecture principles with Domain-Driven Design
51-
- Comprehensive test coverage with CI/CD
52-
- Async/await support for high performance
53-
- Type safety with full Python typing
54-
55-
## 🚀 Quick Start
56-
57-
Choose your preferred way to run Shelly Manager:
58-
59-
### 🐳 Docker (Recommended)
60-
61-
**Web UI + API Stack** (Complete management interface):
31+
**Web UI + API Stack**:
6232

6333
```yaml
6434
services:
6535
api:
66-
image: ghcr.io/jfmlima/shelly-manager/api:latest
36+
image: ghcr.io/jfmlima/shelly-manager-api:latest
6737
ports:
6838
- "8000:8000"
6939
volumes:
@@ -73,7 +43,7 @@ services:
7343
- PORT=8000
7444

7545
web:
76-
image: ghcr.io/jfmlima/shelly-manager/web:latest
46+
image: ghcr.io/jfmlima/shelly-manager-web:latest
7747
ports:
7848
- "8080:8080"
7949
environment:
@@ -82,33 +52,33 @@ services:
8252
- api
8353
```
8454
85-
**CLI Only** (For automation and scripting):
55+
**CLI Only**:
8656
8757
```bash
8858
# Interactive device scanning
8959
docker run --rm -it \
9060
-v ./config.json:/app/config.json:ro \
91-
ghcr.io/jfmlima/shelly-manager/cli:latest \
61+
ghcr.io/jfmlima/shelly-manager-cli:latest \
9262
scan --range 192.168.1.0/24
9363

9464
# Check device status
9565
docker run --rm -it \
96-
ghcr.io/jfmlima/shelly-manager/cli:latest \
66+
ghcr.io/jfmlima/shelly-manager-cli:latest \
9767
device status 192.168.1.100
9868

9969
# Bulk firmware updates
10070
docker run --rm -it \
10171
-v ./config.json:/app/config.json:ro \
102-
ghcr.io/jfmlima/shelly-manager/cli:latest \
72+
ghcr.io/jfmlima/shelly-manager-cli:latest \
10373
bulk update --from-config
10474
```
10575

106-
**API Only** (For custom integrations):
76+
**API Only**:
10777

10878
```bash
10979
docker run -p 8000:8000 \
11080
-v ./config.json:/app/config.json:ro \
111-
ghcr.io/jfmlima/shelly-manager/api:latest
81+
ghcr.io/jfmlima/shelly-manager-api:latest
11282
```
11383

11484
### 📋 Configuration
@@ -257,36 +227,6 @@ We welcome contributions! Here's how to get started:
257227
- 💡 **Feature Requests**: Describe your use case in an issue
258228
- 💬 **Questions**: Start a discussion for general questions
259229

260-
## 🌟 Why Choose Shelly Manager?
261-
262-
### For Home Lab Enthusiasts
263-
264-
- **Complete local control** without cloud dependencies
265-
- **Professional-grade tools** for managing your smart home
266-
- **Easy Docker deployment** for your home server
267-
268-
### For Network Administrators
269-
270-
- **Bulk device management** for commercial deployments
271-
- **API integration** for existing management systems
272-
- **Comprehensive monitoring** and configuration tools
273-
274-
### For Developers
275-
276-
- **Clean, documented APIs** for custom integrations
277-
- **Modern architecture** with comprehensive testing
278-
- **Multiple interfaces** (CLI, Web, REST API) for flexibility
279-
280-
### For Privacy-Conscious Users
281-
282-
- **No cloud connectivity** required
283-
- **Local network operation** only
284-
- **Open source** for complete transparency
285-
286-
## 📄 License
287-
288-
This project is open source and available under the [MIT License](LICENSE).
289-
290-
---
230+
## License
291231

292-
**🏠 Built for local control of your smart home • 🔒 Privacy-first • 🚀 Professional-grade**
232+
MIT License - see [LICENSE](LICENSE) file.

packages/api/README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ REST API server for Shelly Manager built with **Litestar** - a modern, high-perf
2020
# Run API server
2121
docker run -p 8000:8000 \
2222
-v ./config.json:/app/config.json:ro \
23-
ghcr.io/jfmlima/shelly-manager/api:latest
23+
ghcr.io/jfmlima/shelly-manager-api:latest
2424

2525
# Visit API documentation
2626
open http://localhost:8000/docs
@@ -182,15 +182,15 @@ docker run -d \
182182
-v ./config.json:/app/config.json:ro \
183183
-e HOST=0.0.0.0 \
184184
-e PORT=8000 \
185-
ghcr.io/jfmlima/shelly-manager/api:latest
185+
ghcr.io/jfmlima/shelly-manager-api:latest
186186
```
187187

188188
### Docker Compose
189189

190190
```yaml
191191
services:
192192
api:
193-
image: ghcr.io/jfmlima/shelly-manager/api:latest
193+
image: ghcr.io/jfmlima/shelly-manager-api:latest
194194
ports:
195195
- "8000:8000"
196196
volumes:
@@ -315,7 +315,7 @@ Enable debug mode for detailed error messages:
315315
```bash
316316
docker run -p 8000:8000 \
317317
-e DEBUG=true \
318-
ghcr.io/jfmlima/shelly-manager/api:latest
318+
ghcr.io/jfmlima/shelly-manager-api:latest
319319
```
320320

321321
### Logs

packages/cli/README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -19,18 +19,18 @@ A powerful command-line interface for managing Shelly IoT devices locally. Built
1919
```bash
2020
# Scan for devices
2121
docker run --rm -it \
22-
ghcr.io/jfmlima/shelly-manager/cli:latest \
22+
ghcr.io/jfmlima/shelly-manager-cli:latest \
2323
scan --range 192.168.1.0/24
2424

2525
# Device status check
2626
docker run --rm -it \
27-
ghcr.io/jfmlima/shelly-manager/cli:latest \
27+
ghcr.io/jfmlima/shelly-manager-cli:latest \
2828
device status 192.168.1.100
2929

3030
# Using configuration file
3131
docker run --rm -it \
3232
-v ./config.json:/app/config.json:ro \
33-
ghcr.io/jfmlima/shelly-manager/cli:latest \
33+
ghcr.io/jfmlima/shelly-manager-cli:latest \
3434
scan --from-config
3535
```
3636

@@ -275,7 +275,7 @@ ip,status,device_type,device_name,firmware_version,response_time,last_seen
275275
# Run interactive CLI session
276276
docker run --rm -it \
277277
-v ./config.json:/app/config.json:ro \
278-
ghcr.io/jfmlima/shelly-manager/cli:latest \
278+
ghcr.io/jfmlima/shelly-manager-cli:latest \
279279
bash
280280

281281
# Then run commands inside container
@@ -291,7 +291,7 @@ root@container:/app# shelly-manager scan --from-config
291291
docker run --rm \
292292
-v ./config.json:/app/config.json:ro \
293293
-v ./reports:/app/reports \
294-
ghcr.io/jfmlima/shelly-manager/cli:latest \
294+
ghcr.io/jfmlima/shelly-manager-cli:latest \
295295
device status --from-config --export json --export-file /app/reports/status-$(date +%Y%m%d).json
296296
```
297297

@@ -300,7 +300,7 @@ docker run --rm \
300300
```yaml
301301
services:
302302
cli:
303-
image: ghcr.io/jfmlima/shelly-manager/cli:latest
303+
image: ghcr.io/jfmlima/shelly-manager-cli:latest
304304
volumes:
305305
- ./config.json:/app/config.json:ro
306306
- ./reports:/app/reports
@@ -425,7 +425,7 @@ uv run shelly-manager --verbose scan --range 192.168.1.0/24
425425

426426
# Docker
427427
docker run --rm -it \
428-
ghcr.io/jfmlima/shelly-manager/cli:latest \
428+
ghcr.io/jfmlima/shelly-manager-cli:latest \
429429
--verbose scan --range 192.168.1.0/24
430430
```
431431

0 commit comments

Comments
 (0)