Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 1 addition & 0 deletions .serena/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
/cache
66 changes: 66 additions & 0 deletions .serena/memories/code_style_and_conventions.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
# Code Style and Conventions for Lazyssh

## Go Code Style
- **Formatting**: Use `gofumpt` (advanced gofmt) for formatting
- **Imports**: Standard library first, then third-party packages, then local packages
- **Naming**: Use Go naming conventions (PascalCase for exported, camelCase for unexported)
- **Comments**: Use complete sentences starting with name of declared entity
- **Error Handling**: Return errors explicitly, use error wrapping
- **Context**: Pass context.Context for cancellable operations

## File Organization
- **Entry Point**: `cmd/main.go` with cobra root command
- **Clean Architecture**:
- `internal/core/` - domain entities and services
- `internal/adapters/` - UI and data adapters
- Repository pattern for data persistence
- **Configuration**: Use dependency injection pattern

## Documentation
- **README**: Comprehensive with screenshots and installation instructions
- **License**: Apache License 2.0
- **Headers**: All Go files require copyright header

## Pull Request Conventions
- **Semantic PRs**: Use conventional commits format
- `feat:` new features
- `fix:` bug fixes
- `improve:` UX improvements
- `refactor:` code changes
- `docs:` documentation
- `test:` adding tests
- `ci:` CI/CD changes
- `chore:` maintenance
- `revert:` reverts
- **Scopes**: ui, cli, config, parser (optional)

## Testing
- **Unit Tests**: Race detection (`-race` flag)
- **Coverage**: Generate HTML coverage reports
- **Benchmarks**: Use standard Go benchmark format
- **Test Files**: Place alongside source `_test.go`

## Linting & Quality
- **golangci-lint**: Comprehensive linter suite
- **Enabled Linters**: ~25 linters including staticcheck, revive, gocritic
- **Disabled Rules**: Some relaxations for internal packages and tests
- **Copyright Headers**: Enforced via goheader linter
- **Spelling**: US English locale

## Architecture Patterns
- **Hexagonal Architecture** (Ports & Adapters)
- **Dependency Injection** for testability
- **Repository Pattern** for data access
- **Service Layer** for business logic
- **Logging**: Structured logging with zap

## SSH Integration
- **Security First**: Non-destructive config writes with backups
- **Atomic Writes**: Temporary files then rename to prevent corruption
- **Multiple Backups**: Original backup + rotate 10 timestamped backups
- **Permissions**: Preserve file permissions on SSH config

## Internationalization
- **Language**: English US (misspell locale: US)
- **Error Messages**: Clear and actionable
- **UI Text**: Consistent terminology
34 changes: 34 additions & 0 deletions .serena/memories/project_overview.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
# Lazyssh Project Overview

## Purpose
Lazyssh is a terminal-based, interactive SSH server manager built in Go, inspired by tools like lazydocker and k9s. It provides a clean, keyboard-driven UI for navigating, connecting to, managing, and transferring files between local machine and servers defined in ~/.ssh/config. No more remembering IP addresses or running long scp commands.

## Tech Stack
- **Language**: Go 1.24.6
- **Architecture**: Hexagonal/Clean Architecture
- **UI Framework**: tview + tcell (TUI - Terminal User Interface)
- **CLI Framework**: Cobra
- **Configuration Parser**: ssh_config (fork)
- **Logging**: Zap
- **Clipboard**: atotto/clipboard

## Key Features
- 📜 SSH config parsing and management
- ➕ Add/edit/delete server entries via TUI
- 🔍 Fuzzy search by alias, IP, or tags
- 🏷 Server tagging and filtering
- ️pinning and sorting options
- 🏓 Server ping testing
- 🔗 Port forwarding and advanced SSH options
- 🔑 SSH key management and deployment
- 📁 File transfer capabilities (planned)

## Project Structure
- `cmd/` - Application entry point
- `internal/adapters/` - UI and data adapters
- `internal/core/` - Domain logic and services
- `internal/logger/` - Logging infrastructure
- `docs/` - Documentation and screenshots

## Development System
Running on macOS (Darwin) with standard unix utilities.
51 changes: 51 additions & 0 deletions .serena/memories/suggested_commands.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
# Important Commands for Lazyssh Development

## Development Workflow

### Basic Operations
- `git status` - Check current repository state
- `git add .` - Stage all changes
- `git commit -m "message"` - Commit changes
- `git push origin main` - Push to remote
- `git pull origin main` - Pull latest changes

### Building & Running
- `make build` - Build the binary with quality checks
- `make run` - Run the application from source code
- `./bin/lazyssh` - Run the built binary
- `make build-all` - Build binaries for all platforms (Linux/Mac/Windows)

### Code Quality & Testing
- `make quality` - Run all quality checks (fmt, vet, lint)
- `make fmt` - Format code with gofumpt and go fmt
- `make lint` - Run golangci-lint
- `make lint-fix` - Run golangci-lint with automatic fixes
- `make test` - Run unit tests with race detection and coverage
- `make coverage` - Generate and open coverage report
- `make benchmark` - Run benchmark tests

### Dependency Management
- `go mod download` - Download dependencies
- `go mod verify` - Verify dependencies
- `go mod tidy` - Clean up dependencies
- `make deps` - Download and verify dependencies
- `make update-deps` - Update all dependencies to latest

### Maintenance
- `make clean` - Clean build artifacts and caches
- `make version` - Display version information
- `make help` - Show all available make targets

### Quick Commands
- `make run-race` - Run with race detector enabled
- `make test-verbose` - Run tests with verbose output
- `make check` - Run staticcheck analyzer

### System Prerequisites (macOS)
- `brew install go` - Install Go
- `go install golang.org/x/tools/gopls@latest` - Install language server
- Standard unix tools: `ls`, `cd`, `grep`, `find`, `mkdir`, `cp`, `mv`

## Semantic PRs
Use semantic PR titles: `feat(scope): description`, `fix(scope): description`, `refactor(scope): description`
Allowed scopes: ui, cli, config, parser
93 changes: 93 additions & 0 deletions .serena/memories/task_completion_workflow.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,93 @@
# What to do when a development task is completed

## Pre-Commit Quality Checks (Mandatory)
Always run these before committing changes:

```bash
# Run all quality checks
make quality

# This executes:
# - make fmt (formatting with gofumpt + gofmt)
# - make vet (static analysis)
# - make lint (golangci-lint with all configured linters)
```

## Testing (Mandatory)
```bash
# Run tests with race detection and coverage
make test

# Generate coverage report if needed
make coverage
```

## Build Verification
```bash
# Ensure the code builds successfully
make build

# Test that the application runs
make run
```

## Linting & Static Analysis
```bash
# Fix any auto-fixable linting issues
make lint-fix

# Run staticcheck analyzer
make check
```

## Dependency Management
```bash
# Keep dependencies clean
go mod tidy
```

## Commit Message Format
Use semantic commit messages:
- `feat(ui): add server ping functionality`
- `fix(config): handle empty SSH config files`
- `improve(performance): optimize server list rendering`
- `refactor(core): extract server parsing logic`
- `test(services): add unit tests for server validation`
- `docs: update installation instructions`
- `ci: add automated testing workflow`
- `chore: update copyright headers`

## Code Review Checklist
- [ ] All quality checks pass (`make quality`)
- [ ] Tests pass with coverage maintained
- [ ] No new linting violations
- [ ] Code follows established patterns and conventions
- [ ] Security implications considered (especially SSH handling)
- [ ] Performance impact assessed
- [ ] Documentation updated if needed
- [ ] Changelog updated for user-facing changes

## SSH Configuration Safety
When modifying SSH functionality:
- [ ] Backups are properly created
- [ ] Atomic writes are used (temp file then rename)
- [ ] File permissions are preserved
- [ ] Error handling includes rollback scenarios
- [ ] No exposure of sensitive data (private keys, passwords)

## Final Verification
```bash
# One final build and test
make clean && make build
./bin/lazyssh --help # Verify binary works
```

## Staging and Push
```bash
# Stage and commit
git add .
make quality # Final check
make test # Final test
git commit -m "feat(description): your semantic message"
git push origin main
```
67 changes: 67 additions & 0 deletions .serena/project.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
# language of the project (csharp, python, rust, java, typescript, go, cpp, or ruby)
# * For C, use cpp
# * For JavaScript, use typescript
# Special requirements:
# * csharp: Requires the presence of a .sln file in the project folder.
language: go

# whether to use the project's gitignore file to ignore files
# Added on 2025-04-07
ignore_all_files_in_gitignore: true
# list of additional paths to ignore
# same syntax as gitignore, so you can use * and **
# Was previously called `ignored_dirs`, please update your config if you are using that.
# Added (renamed) on 2025-04-07
ignored_paths: []

# whether the project is in read-only mode
# If set to true, all editing tools will be disabled and attempts to use them will result in an error
# Added on 2025-04-18
read_only: false

# list of tool names to exclude. We recommend not excluding any tools, see the readme for more details.
# Below is the complete list of tools for convenience.
# To make sure you have the latest list of tools, and to view their descriptions,
# execute `uv run scripts/print_tool_overview.py`.
#
# * `activate_project`: Activates a project by name.
# * `check_onboarding_performed`: Checks whether project onboarding was already performed.
# * `create_text_file`: Creates/overwrites a file in the project directory.
# * `delete_lines`: Deletes a range of lines within a file.
# * `delete_memory`: Deletes a memory from Serena's project-specific memory store.
# * `execute_shell_command`: Executes a shell command.
# * `find_referencing_code_snippets`: Finds code snippets in which the symbol at the given location is referenced.
# * `find_referencing_symbols`: Finds symbols that reference the symbol at the given location (optionally filtered by type).
# * `find_symbol`: Performs a global (or local) search for symbols with/containing a given name/substring (optionally filtered by type).
# * `get_current_config`: Prints the current configuration of the agent, including the active and available projects, tools, contexts, and modes.
# * `get_symbols_overview`: Gets an overview of the top-level symbols defined in a given file.
# * `initial_instructions`: Gets the initial instructions for the current project.
# Should only be used in settings where the system prompt cannot be set,
# e.g. in clients you have no control over, like Claude Desktop.
# * `insert_after_symbol`: Inserts content after the end of the definition of a given symbol.
# * `insert_at_line`: Inserts content at a given line in a file.
# * `insert_before_symbol`: Inserts content before the beginning of the definition of a given symbol.
# * `list_dir`: Lists files and directories in the given directory (optionally with recursion).
# * `list_memories`: Lists memories in Serena's project-specific memory store.
# * `onboarding`: Performs onboarding (identifying the project structure and essential tasks, e.g. for testing or building).
# * `prepare_for_new_conversation`: Provides instructions for preparing for a new conversation (in order to continue with the necessary context).
# * `read_file`: Reads a file within the project directory.
# * `read_memory`: Reads the memory with the given name from Serena's project-specific memory store.
# * `remove_project`: Removes a project from the Serena configuration.
# * `replace_lines`: Replaces a range of lines within a file with new content.
# * `replace_symbol_body`: Replaces the full definition of a symbol.
# * `restart_language_server`: Restarts the language server, may be necessary when edits not through Serena happen.
# * `search_for_pattern`: Performs a search for a pattern in the project.
# * `summarize_changes`: Provides instructions for summarizing the changes made to the codebase.
# * `switch_modes`: Activates modes by providing a list of their names
# * `think_about_collected_information`: Thinking tool for pondering the completeness of collected information.
# * `think_about_task_adherence`: Thinking tool for determining whether the agent is still on track with the current task.
# * `think_about_whether_you_are_done`: Thinking tool for determining whether the task is truly completed.
# * `write_memory`: Writes a named memory (for future reference) to Serena's project-specific memory store.
excluded_tools: []

# initial prompt for the project. It will always be given to the LLM upon activating the project
# (contrary to the memories, which are loaded on demand).
initial_prompt: ""

project_name: "lazyssh"
Loading