Skip to content
Merged
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
85 changes: 85 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,85 @@
#################
## Common
#################

# env files
.env
.env.development.local
.env.test.local
.env.production.local
.env.local

# Editor/IDE
.idea/
.vscode/
.vscode-test

# AI
.claude/
CLAUDE.md
.roo/
.rooignore
.roorules

# TEMP: Project planning documents
docs/tasks/

#################
## GoLang
#################

# Binaries for programs and plugins
*.exe
*.exe~
*.dll
*.so
*.dylib

# Test binary, built with `go test -c`
*.test

# Code coverage profiles and other test artifacts
*.out
coverage.*
*.coverprofile
profile.cov

# Go workspace file
go.work
go.work.sum

#################
## Node.js
#################

# Logs
logs
*.log
.pnpm-debug.log*

# Diagnostic reports (https://nodejs.org/api/report.html)
report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json

# Runtime data
pids
*.pid
*.seed
*.pid.lock

# Compiled binary addons (https://nodejs.org/api/addons.html)
build/Release

# Dependency directories
node_modules/

# TypeScript cache
*.tsbuildinfo

# Optional eslint cache
.eslintcache

# Optional REPL history
.node_repl_history

# Output of 'npm pack'
*.tgz
53 changes: 53 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
# Contributing to aws-local-sync

Thanks for your interest in contributing to **aws-local-sync**! This guide outlines the basics for setting up your development environment, understanding the project structure, and contributing effectively.

## Development Setup

1. **Clone the repo**

```sh
git clone https://github.com/jakec-dev/aws-local-sync.git
cd aws-local-sync
```

2. **Build the CLI**

```sh
go build -o bin/aws-local-sync ./cmd/aws-local-sync
```

3. **Run it**

```sh
./bin/aws-local-sync
```

4. **Run tests**

(Test suite coming soon)

## Contributing Guidelines

- Feature requests and bug reports are welcome via GitHub Issues.
- Follow idiomatic Go and ensure your code passes go fmt.
- Use semantic commits (e.g., feat: add support for S3 source).
- Prefer small, focused pull requests with clear descriptions.

## Project Structure

```text
cmd/aws-local-sync/ # CLI entry point (main.go) using Cobra
internal/ # Core logic (sync engine, providers, targets)
├── sync/ # Sync manager and orchestration
├── providers/ # AWS service-specific data exporters
├── targets/ # Local import destinations (e.g. Docker, dir)
└── config/ # YAML parsing, validation, and discovery
pkg/ # Optional: shared libraries (exported APIs)
scripts/ # Dev scripts and tooling
testdata/ # Synthetic data for testing
```

## Thanks!

Your contributions help make aws-local-sync better for everyone. Whether it's fixing bugs, suggesting features, or improving docs — you're appreciated.
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2025 Jake Clayton

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
47 changes: 46 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1 +1,46 @@
# aws-local-sync
# aws-local-sync

**aws-local-sync** is a high-performance CLI tool that syncs data from AWS services into your local development environment. It's designed to be **simple**, **fast**, **reliable**, and **developer-friendly**, with support for plugins, caching, and seamless workflow integration.

Key features:

- ⚡ Zero-config for common syncs
- 🔁 Reliable with retries, caching, and recovery
- 🔌 Extensible architecture (providers & targets)
- 🧠 Developer-friendly CLI with helpful commands
- 📦 Node.js wrapper for easy cross-platform installs

> This project is currently in active development. Expect rapid iteration, breaking changes, and new modules as core components are implemented.
## Getting Started

### Option 1: Install with Go

```sh
go install github.com/jakec-dev/aws-local-sync/cmd/aws-local-sync@latest

# Then use it from anywhere:
aws-local-sync
```

### Option 2: Run from source

```sh
# Clone the repo
git clone https://github.com/jakec-dev/aws-local-sync.git
cd aws-local-sync

# Build the CLI
go build -o bin/aws-local-sync ./cmd/aws-local-sync

# Run the CLI
./bin/aws-local-sync
```

## Contributing

See [CONTRIBUTING.md](CONTRIBUTING.md) for development guidelines.

## License

This project is licensed under the [MIT License](LICENSE).
Empty file added build/.gitkeep
Empty file.
7 changes: 7 additions & 0 deletions cmd/aws-local-sync/main.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
package main

import "fmt"

func main() {
fmt.Println("Placeholder")
}
Empty file added docs/.gitkeep
Empty file.
3 changes: 3 additions & 0 deletions go.mod
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
module github.com/jakec-dev/aws-local-sync

go 1.24.3
Empty file added internal/config/.gitkeep
Empty file.
Empty file added internal/providers/.gitkeep
Empty file.
Empty file added internal/sync/.gitkeep
Empty file.