Skip to content

Commit 9fc63be

Browse files
committed
docs: add dnstc scaffolding issue draft
1 parent 903630a commit 9fc63be

1 file changed

Lines changed: 46 additions & 0 deletions

File tree

issues/dnstc-01-scaffolding.md

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
# Project Scaffolding
2+
3+
## Summary
4+
5+
Set up the basic Go project structure for dnstc with CLI framework and shared library integration.
6+
7+
**Motivation:** Foundation for all other features. Consistent project structure with other net2share Go tools.
8+
9+
## Design
10+
11+
- Go module: `github.com/net2share/dnstc`
12+
- CLI framework: [cobra](https://github.com/spf13/cobra)
13+
- Shared library: [go-corelib](https://github.com/net2share/go-corelib) for OS detection and TUI
14+
- Cross-platform support: Windows, macOS, Linux
15+
16+
### Interactive Menu
17+
18+
Run without arguments for interactive menu:
19+
```bash
20+
dnstc
21+
```
22+
23+
Menu options (placeholder):
24+
- Start tunnel
25+
- Stop tunnel
26+
- Status
27+
- Configuration
28+
- Exit
29+
30+
### CLI Commands
31+
32+
```bash
33+
dnstc start # Start tunnel service
34+
dnstc stop # Stop tunnel service
35+
dnstc status # Show current status
36+
dnstc config # Show/edit configuration
37+
```
38+
39+
### Flags
40+
41+
Common flags across commands:
42+
- `--config` - Path to config file
43+
- `--verbose` - Enable verbose output
44+
- `--help` - Show help
45+
46+
**Scope:** This issue is about creating the project structure, menu, and command skeleton only. Commands and menus should display dummy/placeholder text. No actual functionality - that comes in later issues.

0 commit comments

Comments
 (0)