From 3b21ec5867ddc810a7b001e50c9e4ed3c08ed710 Mon Sep 17 00:00:00 2001 From: blu3 Date: Fri, 31 Jan 2025 11:51:52 +0300 Subject: [PATCH 01/18] Update CI and now upload artifacts --- .github/workflows/ci.yml | 104 +++++++++++++++++++++++---------------- 1 file changed, 61 insertions(+), 43 deletions(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 4278bd37..d1c9084d 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -1,52 +1,70 @@ name: CI + on: push: - branches: [main] pull_request: - branches: [main] + workflow_dispatch: jobs: unit-tests: name: Go unit tests - runs-on: ubuntu-latest + runs-on: ubuntu-24.04 steps: - - uses: actions/checkout@v4 - - uses: actions/setup-go@v5 - with: - go-version: '1.23' - - run: go version - - run: go test -v ./... - - name: Build files - run: | - go version - CGO_ENABLED=0 GOOS=windows GOARCH=amd64 go build -ldflags '-extldflags "-static"' -o croc.exe - CGO_ENABLED=0 GOOS=windows GOARCH=386 go build -ldflags '-extldflags "-static"' -o croc.exe - CGO_ENABLED=0 GOOS=windows GOARCH=arm go build -ldflags '-extldflags "-static"' -o croc.exe - CGO_ENABLED=0 GOOS=windows GOARCH=arm64 go build -ldflags '-extldflags "-static"' -o croc.exe - CGO_ENABLED=0 GOOS=linux GOARCH=amd64 go build -ldflags '-extldflags "-static"' -o croc - CGO_ENABLED=0 GOOS=linux GOARCH=386 go build -ldflags '-extldflags "-static"' -o croc - CGO_ENABLED=0 GOOS=linux GOARCH=arm go build -ldflags '-extldflags "-static"' -o croc - GOARM=5 CGO_ENABLED=0 GOOS=linux GOARCH=arm go build -ldflags '-extldflags "-static"' -o croc - CGO_ENABLED=0 GOOS=linux GOARCH=arm64 go build -ldflags '-extldflags "-static"' -o croc - CGO_ENABLED=0 GOOS=darwin GOARCH=amd64 go build -ldflags '-s -extldflags "-sectcreate __TEXT __info_plist Info.plist"' -o croc - CGO_ENABLED=0 GOOS=darwin GOARCH=arm64 go build -ldflags '-s -extldflags "-sectcreate __TEXT __info_plist Info.plist"' -o croc - CGO_ENABLED=0 GOOS=dragonfly GOARCH=amd64 go build -ldflags '' -o croc - CGO_ENABLED=0 GOOS=freebsd GOARCH=amd64 go build -ldflags '' -o croc - CGO_ENABLED=0 GOOS=freebsd GOARCH=arm64 go build -ldflags '' -o croc - CGO_ENABLED=0 GOOS=netbsd GOARCH=386 go build -ldflags '' -o croc - CGO_ENABLED=0 GOOS=netbsd GOARCH=amd64 go build -ldflags '' -o croc - CGO_ENABLED=0 GOOS=netbsd GOARCH=arm64 go build -ldflags '' -o croc - CGO_ENABLED=0 GOOS=openbsd GOARCH=amd64 go build -ldflags '' -o croc - CGO_ENABLED=0 GOOS=openbsd GOARCH=arm64 go build -ldflags '' -o croc - - name: Setup Go - uses: actions/setup-go@v5 - with: - go-version: '1.20.7' # go1.20.8+ refuses to build go1.22 code... - - name: Build Windows 7 - run: | - go version - rm go.mod go.sum - go mod init github.com/schollz/croc/v10 - go mod tidy - CGO_ENABLED=0 GOOS=windows GOARCH=amd64 go build -ldflags '-extldflags "-static"' -o croc.exe - CGO_ENABLED=0 GOOS=windows GOARCH=386 go build -ldflags '-extldflags "-static"' -o croc.exe + - name: Checkout repository + uses: actions/checkout@v4 + + - name: Setup Go + uses: actions/setup-go@v5 + with: + go-version: '^1.23.5' + + - name: Display Go version + run: go version + + - name: Run unit tests + run: go test -v ./... + + - name: Build files + run: | + go version + CGO_ENABLED=0 GOOS=windows GOARCH=amd64 go build -ldflags '-extldflags "-static"' -o croc-windows-amd64.exe + CGO_ENABLED=0 GOOS=windows GOARCH=386 go build -ldflags '-extldflags "-static"' -o croc-windows-386.exe + CGO_ENABLED=0 GOOS=windows GOARCH=arm go build -ldflags '-extldflags "-static"' -o croc-windows-arm.exe + CGO_ENABLED=0 GOOS=windows GOARCH=arm64 go build -ldflags '-extldflags "-static"' -o croc-windows-arm64.exe + CGO_ENABLED=0 GOOS=linux GOARCH=amd64 go build -ldflags '-extldflags "-static"' -o croc-linux-amd64 + CGO_ENABLED=0 GOOS=linux GOARCH=386 go build -ldflags '-extldflags "-static"' -o croc-linux-386 + CGO_ENABLED=0 GOOS=linux GOARCH=arm go build -ldflags '-extldflags "-static"' -o croc-linux-arm + GOARM=5 CGO_ENABLED=0 GOOS=linux GOARCH=arm go build -ldflags '-extldflags "-static"' -o croc-linux-arm5 + CGO_ENABLED=0 GOOS=linux GOARCH=arm64 go build -ldflags '-extldflags "-static"' -o croc-linux-arm64 + CGO_ENABLED=0 GOOS=darwin GOARCH=amd64 go build -ldflags '-s -extldflags "-sectcreate __TEXT __info_plist Info.plist"' -o croc-darwin-amd64 + CGO_ENABLED=0 GOOS=darwin GOARCH=arm64 go build -ldflags '-s -extldflags "-sectcreate __TEXT __info_plist Info.plist"' -o croc-darwin-arm64 + CGO_ENABLED=0 GOOS=freebsd GOARCH=amd64 go build -ldflags '' -o croc-freebsd-amd64 + CGO_ENABLED=0 GOOS=freebsd GOARCH=arm64 go build -ldflags '' -o croc-freebsd-arm64 + CGO_ENABLED=0 GOOS=openbsd GOARCH=amd64 go build -ldflags '' -o croc-openbsd-amd64 + CGO_ENABLED=0 GOOS=openbsd GOARCH=arm64 go build -ldflags '' -o croc-openbsd-arm64 + + - name: Setup Go for Windows 7 Build + uses: actions/setup-go@v5 + with: + go-version: '1.20.7' # Go 1.20.8+ refuses to build Go 1.23 code + + - name: Build Windows 7 version + run: | + go version + rm go.mod go.sum + go mod init github.com/schollz/croc/v10 + go mod tidy + CGO_ENABLED=0 GOOS=windows GOARCH=amd64 go build -ldflags '-extldflags "-static"' -o croc-windows7-amd64.exe + CGO_ENABLED=0 GOOS=windows GOARCH=386 go build -ldflags '-extldflags "-static"' -o croc-windows7-386.exe + + - name: Upload build artifacts + uses: actions/upload-artifact@v4 + with: + name: croc-build-artifacts + path: | + croc-windows-*.exe + croc-linux-* + croc-darwin-* + croc-freebsd-* + croc-openbsd-* + croc-windows7-*.exe From 55624c7b635ff963197e4802f0d3ac619a9503c1 Mon Sep 17 00:00:00 2001 From: blu3 Date: Fri, 31 Jan 2025 11:57:55 +0300 Subject: [PATCH 02/18] Reformat --- .github/workflows/deploy.yml | 43 ++++++++++++------------------------ 1 file changed, 14 insertions(+), 29 deletions(-) diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml index 305739ad..da42dade 100644 --- a/.github/workflows/deploy.yml +++ b/.github/workflows/deploy.yml @@ -1,37 +1,22 @@ -# This is a basic workflow to help you get started with Actions +name: Deploy Docker -name: CD - -# Controls when the action will run. on: - # Triggers the workflow on push or pull request events but only for the main branch push: - branches: - - '*' - tags: - - 'v*' pull_request: - branches: - - '*' - - # Allows you to run this workflow manually from the Actions tab workflow_dispatch: -# A workflow run is made up of one or more jobs that can run sequentially or in parallel jobs: docker: - runs-on: ubuntu-latest + runs-on: ubuntu-24.04 steps: - - - name: Checkout + - name: Checkout repository uses: actions/checkout@v4 - - - name: Docker meta - id: docker_meta + + - name: Docker meta + id: meta uses: docker/metadata-action@v5 with: images: schollz/croc - # generate Docker tags based on the following events/attributes tags: | type=ref,event=branch type=ref,event=pr @@ -39,21 +24,21 @@ jobs: type=semver,pattern={{major}}.{{minor}} type=semver,pattern={{major}} type=sha - - - name: Set up QEMU + + - name: Setup QEMU uses: docker/setup-qemu-action@v3 - - - name: Set up Docker Buildx + + - name: Set up Docker Buildx uses: docker/setup-buildx-action@v3 - - - name: Login to DockerHub + + - name: Login to DockerHub if: github.event_name != 'pull_request' uses: docker/login-action@v3 with: username: ${{ secrets.DOCKERHUB_USERNAME }} password: ${{ secrets.DOCKERHUB_TOKEN }} - - - name: Build and push + + - name: Build and push uses: docker/build-push-action@v6 with: context: . From 4ac9f12a23aa1b7987e1dccfdb1dffffee05dba2 Mon Sep 17 00:00:00 2001 From: blu3 Date: Fri, 31 Jan 2025 12:04:28 +0300 Subject: [PATCH 03/18] Update stale action --- .github/workflows/stale.yml | 25 ++++++++++--------------- 1 file changed, 10 insertions(+), 15 deletions(-) diff --git a/.github/workflows/stale.yml b/.github/workflows/stale.yml index 1e3ae32b..8a1d996a 100644 --- a/.github/workflows/stale.yml +++ b/.github/workflows/stale.yml @@ -1,27 +1,22 @@ -# This workflow warns and then closes issues and PRs that have had no activity for a specified amount of time. -# -# You can adjust the behavior by modifying this file. -# For more information, see: -# https://github.com/actions/stale name: Mark stale issues and pull requests on: schedule: - - cron: '19 12 * * *' + - cron: '0 0 * * *' jobs: stale: - - runs-on: ubuntu-latest + runs-on: ubuntu-24.04 permissions: issues: write pull-requests: write steps: - - uses: actions/stale@v9 - with: - repo-token: ${{ secrets.GITHUB_TOKEN }} - stale-issue-message: 'Stale issue message' - stale-pr-message: 'Stale pull request message' - stale-issue-label: 'no-issue-activity' - stale-pr-label: 'no-pr-activity' + - name: Stale + uses: actions/stale@v9 + with: + repo-token: ${{ secrets.GITHUB_TOKEN }} + stale-issue-message: 'This issue has been marked stale because it has been open for 60 days with no activity.' + stale-pr-message: 'This pull request has been marked stale because it has been open for 60 days with no activity.' + stale-issue-label: 'no-issue-activity' + stale-pr-label: 'no-pr-activity' From a092a84886d6554146707e68b55b4f554d4c6001 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Fri, 31 Jan 2025 09:05:48 +0000 Subject: [PATCH 04/18] build(deps): bump github.com/stretchr/testify from 1.9.0 to 1.10.0 Bumps [github.com/stretchr/testify](https://github.com/stretchr/testify) from 1.9.0 to 1.10.0. - [Release notes](https://github.com/stretchr/testify/releases) - [Commits](https://github.com/stretchr/testify/compare/v1.9.0...v1.10.0) --- updated-dependencies: - dependency-name: github.com/stretchr/testify dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] --- go.mod | 2 +- go.sum | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/go.mod b/go.mod index 49427841..d8edee17 100644 --- a/go.mod +++ b/go.mod @@ -18,7 +18,7 @@ require ( github.com/schollz/peerdiscovery v1.7.6 github.com/schollz/progressbar/v3 v3.18.0 github.com/skip2/go-qrcode v0.0.0-20200617195104-da1b6568686e - github.com/stretchr/testify v1.9.0 + github.com/stretchr/testify v1.10.0 golang.org/x/crypto v0.32.0 golang.org/x/net v0.34.0 golang.org/x/sys v0.29.0 diff --git a/go.sum b/go.sum index 1bff132f..311c5396 100644 --- a/go.sum +++ b/go.sum @@ -52,8 +52,8 @@ github.com/skip2/go-qrcode v0.0.0-20200617195104-da1b6568686e h1:MRM5ITcdelLK2j1 github.com/skip2/go-qrcode v0.0.0-20200617195104-da1b6568686e/go.mod h1:XV66xRDqSt+GTGFMVlhk3ULuV0y9ZmzeVGR4mloJI3M= github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME= github.com/stretchr/testify v1.6.1/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg= -github.com/stretchr/testify v1.9.0 h1:HtqpIVDClZ4nwg75+f6Lvsy/wHu+3BoSGCbBAcpTsTg= -github.com/stretchr/testify v1.9.0/go.mod h1:r2ic/lqez/lEtzL7wO/rwa5dbSLXVDPFyf8C91i36aY= +github.com/stretchr/testify v1.10.0 h1:Xv5erBjTwe/5IxqUQTdXv5kgmIvbHo3QQyRwhJsOfJA= +github.com/stretchr/testify v1.10.0/go.mod h1:r2ic/lqez/lEtzL7wO/rwa5dbSLXVDPFyf8C91i36aY= github.com/tscholl2/siec v0.0.0-20210707234609-9bdfc483d499/go.mod h1:KL9+ubr1JZdaKjgAaHr+tCytEncXBa1pR6FjbTsOJnw= github.com/tscholl2/siec v0.0.0-20240310163802-c2c6f6198406 h1:sDWDZkwYqX0jvLWstKzFwh+pYhQNaVg65BgSkCP/f7U= github.com/tscholl2/siec v0.0.0-20240310163802-c2c6f6198406/go.mod h1:KL9+ubr1JZdaKjgAaHr+tCytEncXBa1pR6FjbTsOJnw= From ea604bcc6ab23c51a0a94b0e3218416587244a0b Mon Sep 17 00:00:00 2001 From: blu3 Date: Fri, 31 Jan 2025 16:18:37 +0300 Subject: [PATCH 05/18] Update gitignore --- .gitignore | 36 ++++++++++++++++++++++++------------ 1 file changed, 24 insertions(+), 12 deletions(-) diff --git a/.gitignore b/.gitignore index 59ac27db..6f72f892 100644 --- a/.gitignore +++ b/.gitignore @@ -1,13 +1,25 @@ -# Binaries -/croc -/croc.exe -zsh_autocomplete -bash_autocomplete -dist -bin -croc-stdin* +# If you prefer the allow list template instead of the deny list, see community template: +# https://github.com/github/gitignore/blob/main/community/Golang/Go.AllowList.gitignore +# +# Binaries for programs and plugins +*.exe +*.exe~ +*.dll +*.so +*.dylib -.idea/ -.vscode/ -src/utils/bigfile.test -test1/ +# Test binary, built with `go test -c` +*.test + +# Output of the go coverage tool, specifically when used with LiteIDE +*.out + +# Dependency directories (remove the comment below to include it) +# vendor/ + +# Go workspace file +go.work +go.work.sum + +# env file +.env From c8c25ffe42266ddbc9d6cf60bf1cbf5901da7201 Mon Sep 17 00:00:00 2001 From: blu3 Date: Fri, 31 Jan 2025 16:30:12 +0300 Subject: [PATCH 06/18] Change cli to official repo --- go.mod | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/go.mod b/go.mod index d8edee17..845f0baa 100644 --- a/go.mod +++ b/go.mod @@ -1,8 +1,8 @@ module github.com/schollz/croc/v10 -go 1.22 +go 1.23 -toolchain go1.23.1 +toolchain go1.23.5 require ( github.com/cespare/xxhash/v2 v2.3.0 @@ -12,7 +12,7 @@ require ( github.com/magisterquis/connectproxy v0.0.0-20200725203833-3582e84f0c9b github.com/minio/highwayhash v1.0.3 github.com/sabhiram/go-gitignore v0.0.0-20210923224102-525f6e181f06 - github.com/schollz/cli/v2 v2.2.1 + github.com/urfave/cli v2.27.5 github.com/schollz/logger v1.2.0 github.com/schollz/pake/v3 v3.0.5 github.com/schollz/peerdiscovery v1.7.6 From f236b80095de4eec7b82dfa5c899c9e7a6765792 Mon Sep 17 00:00:00 2001 From: blu3 Date: Fri, 31 Jan 2025 16:31:41 +0300 Subject: [PATCH 07/18] Update release action --- .github/workflows/release.yml | 245 +++++++++++++++++----------------- 1 file changed, 126 insertions(+), 119 deletions(-) diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index 3b20b2bc..66ac9113 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -1,4 +1,4 @@ -name: Make release +name: Release on: release: @@ -10,122 +10,129 @@ permissions: jobs: build: - runs-on: ubuntu-latest + runs-on: ubuntu-24.04 steps: - - name: Checkout project - uses: actions/checkout@v4 - - name: Setup Go - uses: actions/setup-go@v4 - with: - go-version: '1.23' - - name: Prepare source tarball - run: | - git clone -b ${{ github.event.release.name }} --depth 1 https://github.com/schollz/croc croc-${{ github.event.release.name }} - cd croc-${{ github.event.release.name }} && go mod tidy && go mod vendor - cd .. && tar -czvf croc_${{ github.event.release.name }}_src.tar.gz croc-${{ github.event.release.name }} - - name: Build files - run: | - CGO_ENABLED=0 GOOS=windows GOARCH=amd64 go build -ldflags '-extldflags "-static"' -o croc.exe - zip croc_${{ github.event.release.name }}_Windows-64bit.zip croc.exe LICENSE - CGO_ENABLED=0 GOOS=windows GOARCH=386 go build -ldflags '-extldflags "-static"' -o croc.exe - zip croc_${{ github.event.release.name }}_Windows-32bit.zip croc.exe LICENSE - CGO_ENABLED=0 GOOS=windows GOARCH=arm go build -ldflags '-extldflags "-static"' -o croc.exe - zip croc_${{ github.event.release.name }}_Windows-ARM.zip croc.exe LICENSE - CGO_ENABLED=0 GOOS=windows GOARCH=arm64 go build -ldflags '-extldflags "-static"' -o croc.exe - zip croc_${{ github.event.release.name }}_Windows-ARM64.zip croc.exe LICENSE - CGO_ENABLED=0 GOOS=linux GOARCH=amd64 go build -ldflags '-extldflags "-static"' -o croc - tar -czvf croc_${{ github.event.release.name }}_Linux-64bit.tar.gz croc LICENSE - CGO_ENABLED=0 GOOS=linux GOARCH=386 go build -ldflags '-extldflags "-static"' -o croc - tar -czvf croc_${{ github.event.release.name }}_Linux-32bit.tar.gz croc LICENSE - CGO_ENABLED=0 GOOS=linux GOARCH=arm go build -ldflags '-extldflags "-static"' -o croc - tar -czvf croc_${{ github.event.release.name }}_Linux-ARM.tar.gz croc LICENSE - GOARM=5 CGO_ENABLED=0 GOOS=linux GOARCH=arm go build -ldflags '-extldflags "-static"' -o croc - tar -czvf croc_${{ github.event.release.name }}_Linux-ARMv5.tar.gz croc LICENSE - CGO_ENABLED=0 GOOS=linux GOARCH=arm64 go build -ldflags '-extldflags "-static"' -o croc - tar -czvf croc_${{ github.event.release.name }}_Linux-ARM64.tar.gz croc LICENSE - CGO_ENABLED=0 GOOS=darwin GOARCH=amd64 go build -ldflags '-s -extldflags "-sectcreate __TEXT __info_plist Info.plist"' -o croc - tar -czvf croc_${{ github.event.release.name }}_macOS-64bit.tar.gz croc LICENSE - CGO_ENABLED=0 GOOS=darwin GOARCH=arm64 go build -ldflags '-s -extldflags "-sectcreate __TEXT __info_plist Info.plist"' -o croc - tar -czvf croc_${{ github.event.release.name }}_macOS-ARM64.tar.gz croc LICENSE - CGO_ENABLED=0 GOOS=dragonfly GOARCH=amd64 go build -ldflags '' -o croc - tar -czvf croc_${{ github.event.release.name }}_DragonFlyBSD-64bit.tar.gz croc LICENSE - CGO_ENABLED=0 GOOS=freebsd GOARCH=amd64 go build -ldflags '' -o croc - tar -czvf croc_${{ github.event.release.name }}_FreeBSD-64bit.tar.gz croc LICENSE - CGO_ENABLED=0 GOOS=freebsd GOARCH=arm64 go build -ldflags '' -o croc - tar -czvf croc_${{ github.event.release.name }}_FreeBSD-ARM64.tar.gz croc LICENSE - CGO_ENABLED=0 GOOS=netbsd GOARCH=386 go build -ldflags '' -o croc - tar -czvf croc_${{ github.event.release.name }}_NetBSD-32bit.tar.gz croc LICENSE - CGO_ENABLED=0 GOOS=netbsd GOARCH=amd64 go build -ldflags '' -o croc - tar -czvf croc_${{ github.event.release.name }}_NetBSD-64bit.tar.gz croc LICENSE - CGO_ENABLED=0 GOOS=netbsd GOARCH=arm64 go build -ldflags '' -o croc - tar -czvf croc_${{ github.event.release.name }}_NetBSD-ARM64.tar.gz croc LICENSE - CGO_ENABLED=0 GOOS=openbsd GOARCH=amd64 go build -ldflags '' -o croc - tar -czvf croc_${{ github.event.release.name }}_OpenBSD-64bit.tar.gz croc LICENSE - CGO_ENABLED=0 GOOS=openbsd GOARCH=arm64 go build -ldflags '' -o croc - tar -czvf croc_${{ github.event.release.name }}_OpenBSD-ARM64.tar.gz croc LICENSE - - name: Setup Go - uses: actions/setup-go@v5 - with: - go-version: '1.20.7' # go1.20.8+ refuses to build go1.22 code... - - name: Build Windows 7 - run: | - go version - rm go.mod go.sum - go mod init github.com/schollz/croc/v10 - go mod tidy - CGO_ENABLED=0 GOOS=windows GOARCH=amd64 go build -ldflags '-extldflags "-static"' -o croc.exe - zip croc_${{ github.event.release.name }}_Windows7-64bit.zip croc.exe - CGO_ENABLED=0 GOOS=windows GOARCH=386 go build -ldflags '-extldflags "-static"' -o croc.exe - zip croc_${{ github.event.release.name }}_Windows7-32bit.zip croc.exe - - name: Create checksums.txt - run: | - touch croc_${{ github.event.release.name }}_checksums.txt - sha256sum croc_${{ github.event.release.name }}_src.tar.gz >> croc_${{ github.event.release.name }}_checksums.txt - sha256sum croc_${{ github.event.release.name }}_Windows-64bit.zip >> croc_${{ github.event.release.name }}_checksums.txt - sha256sum croc_${{ github.event.release.name }}_Windows-32bit.zip >> croc_${{ github.event.release.name }}_checksums.txt - sha256sum croc_${{ github.event.release.name }}_Windows-ARM.zip >> croc_${{ github.event.release.name }}_checksums.txt - sha256sum croc_${{ github.event.release.name }}_Windows-ARM64.zip >> croc_${{ github.event.release.name }}_checksums.txt - sha256sum croc_${{ github.event.release.name }}_Windows7-64bit.zip >> croc_${{ github.event.release.name }}_checksums.txt - sha256sum croc_${{ github.event.release.name }}_Windows7-32bit.zip >> croc_${{ github.event.release.name }}_checksums.txt - sha256sum croc_${{ github.event.release.name }}_Linux-64bit.tar.gz >> croc_${{ github.event.release.name }}_checksums.txt - sha256sum croc_${{ github.event.release.name }}_Linux-32bit.tar.gz >> croc_${{ github.event.release.name }}_checksums.txt - sha256sum croc_${{ github.event.release.name }}_Linux-ARM.tar.gz >> croc_${{ github.event.release.name }}_checksums.txt - sha256sum croc_${{ github.event.release.name }}_Linux-ARMv5.tar.gz >> croc_${{ github.event.release.name }}_checksums.txt - sha256sum croc_${{ github.event.release.name }}_Linux-ARM64.tar.gz >> croc_${{ github.event.release.name }}_checksums.txt - sha256sum croc_${{ github.event.release.name }}_macOS-64bit.tar.gz >> croc_${{ github.event.release.name }}_checksums.txt - sha256sum croc_${{ github.event.release.name }}_macOS-ARM64.tar.gz >> croc_${{ github.event.release.name }}_checksums.txt - sha256sum croc_${{ github.event.release.name }}_DragonFlyBSD-64bit.tar.gz >> croc_${{ github.event.release.name }}_checksums.txt - sha256sum croc_${{ github.event.release.name }}_FreeBSD-64bit.tar.gz >> croc_${{ github.event.release.name }}_checksums.txt - sha256sum croc_${{ github.event.release.name }}_FreeBSD-ARM64.tar.gz >> croc_${{ github.event.release.name }}_checksums.txt - sha256sum croc_${{ github.event.release.name }}_NetBSD-32bit.tar.gz >> croc_${{ github.event.release.name }}_checksums.txt - sha256sum croc_${{ github.event.release.name }}_NetBSD-64bit.tar.gz >> croc_${{ github.event.release.name }}_checksums.txt - sha256sum croc_${{ github.event.release.name }}_NetBSD-ARM64.tar.gz >> croc_${{ github.event.release.name }}_checksums.txt - sha256sum croc_${{ github.event.release.name }}_OpenBSD-64bit.tar.gz >> croc_${{ github.event.release.name }}_checksums.txt - sha256sum croc_${{ github.event.release.name }}_OpenBSD-ARM64.tar.gz >> croc_${{ github.event.release.name }}_checksums.txt - - name: Release - uses: softprops/action-gh-release@v2 - with: - files: | - croc_${{ github.event.release.name }}_checksums.txt - croc_${{ github.event.release.name }}_src.tar.gz - croc_${{ github.event.release.name }}_Windows-64bit.zip - croc_${{ github.event.release.name }}_Windows-32bit.zip - croc_${{ github.event.release.name }}_Windows-ARM.zip - croc_${{ github.event.release.name }}_Windows-ARM64.zip - croc_${{ github.event.release.name }}_Windows7-64bit.zip - croc_${{ github.event.release.name }}_Windows7-32bit.zip - croc_${{ github.event.release.name }}_Linux-64bit.tar.gz - croc_${{ github.event.release.name }}_Linux-32bit.tar.gz - croc_${{ github.event.release.name }}_Linux-ARM.tar.gz - croc_${{ github.event.release.name }}_Linux-ARMv5.tar.gz - croc_${{ github.event.release.name }}_Linux-ARM64.tar.gz - croc_${{ github.event.release.name }}_macOS-64bit.tar.gz - croc_${{ github.event.release.name }}_macOS-ARM64.tar.gz - croc_${{ github.event.release.name }}_DragonFlyBSD-64bit.tar.gz - croc_${{ github.event.release.name }}_FreeBSD-64bit.tar.gz - croc_${{ github.event.release.name }}_FreeBSD-ARM64.tar.gz - croc_${{ github.event.release.name }}_NetBSD-32bit.tar.gz - croc_${{ github.event.release.name }}_NetBSD-64bit.tar.gz - croc_${{ github.event.release.name }}_NetBSD-ARM64.tar.gz - croc_${{ github.event.release.name }}_OpenBSD-64bit.tar.gz - croc_${{ github.event.release.name }}_OpenBSD-ARM64.tar.gz + - name: Checkout repository + uses: actions/checkout@v4 + + - name: Setup Go + uses: actions/setup-go@v5 + with: + go-version: '^1.23.5' + + - name: Prepare source tarball + run: | + git clone -b ${{ github.event.release.name }} --depth 1 https://github.com/schollz/croc croc-${{ github.event.release.name }} + cd croc-${{ github.event.release.name }} && go mod tidy && go mod vendor + cd .. && tar -czvf croc_${{ github.event.release.name }}_src.tar.gz croc-${{ github.event.release.name }} + + - name: Build files + run: | + CGO_ENABLED=0 GOOS=windows GOARCH=amd64 go build -ldflags '-extldflags "-static"' -o croc.exe + zip croc_${{ github.event.release.name }}_Windows-64bit.zip croc.exe LICENSE + CGO_ENABLED=0 GOOS=windows GOARCH=386 go build -ldflags '-extldflags "-static"' -o croc.exe + zip croc_${{ github.event.release.name }}_Windows-32bit.zip croc.exe LICENSE + CGO_ENABLED=0 GOOS=windows GOARCH=arm go build -ldflags '-extldflags "-static"' -o croc.exe + zip croc_${{ github.event.release.name }}_Windows-ARM.zip croc.exe LICENSE + CGO_ENABLED=0 GOOS=windows GOARCH=arm64 go build -ldflags '-extldflags "-static"' -o croc.exe + zip croc_${{ github.event.release.name }}_Windows-ARM64.zip croc.exe LICENSE + CGO_ENABLED=0 GOOS=linux GOARCH=amd64 go build -ldflags '-extldflags "-static"' -o croc + tar -czvf croc_${{ github.event.release.name }}_Linux-64bit.tar.gz croc LICENSE + CGO_ENABLED=0 GOOS=linux GOARCH=386 go build -ldflags '-extldflags "-static"' -o croc + tar -czvf croc_${{ github.event.release.name }}_Linux-32bit.tar.gz croc LICENSE + CGO_ENABLED=0 GOOS=linux GOARCH=arm go build -ldflags '-extldflags "-static"' -o croc + tar -czvf croc_${{ github.event.release.name }}_Linux-ARM.tar.gz croc LICENSE + GOARM=5 CGO_ENABLED=0 GOOS=linux GOARCH=arm go build -ldflags '-extldflags "-static"' -o croc + tar -czvf croc_${{ github.event.release.name }}_Linux-ARMv5.tar.gz croc LICENSE + CGO_ENABLED=0 GOOS=linux GOARCH=arm64 go build -ldflags '-extldflags "-static"' -o croc + tar -czvf croc_${{ github.event.release.name }}_Linux-ARM64.tar.gz croc LICENSE + CGO_ENABLED=0 GOOS=darwin GOARCH=amd64 go build -ldflags '-s -extldflags "-sectcreate __TEXT __info_plist Info.plist"' -o croc + tar -czvf croc_${{ github.event.release.name }}_macOS-64bit.tar.gz croc LICENSE + CGO_ENABLED=0 GOOS=darwin GOARCH=arm64 go build -ldflags '-s -extldflags "-sectcreate __TEXT __info_plist Info.plist"' -o croc + tar -czvf croc_${{ github.event.release.name }}_macOS-ARM64.tar.gz croc LICENSE + CGO_ENABLED=0 GOOS=dragonfly GOARCH=amd64 go build -ldflags '' -o croc + tar -czvf croc_${{ github.event.release.name }}_DragonFlyBSD-64bit.tar.gz croc LICENSE + CGO_ENABLED=0 GOOS=freebsd GOARCH=amd64 go build -ldflags '' -o croc + tar -czvf croc_${{ github.event.release.name }}_FreeBSD-64bit.tar.gz croc LICENSE + CGO_ENABLED=0 GOOS=freebsd GOARCH=arm64 go build -ldflags '' -o croc + tar -czvf croc_${{ github.event.release.name }}_FreeBSD-ARM64.tar.gz croc LICENSE + CGO_ENABLED=0 GOOS=netbsd GOARCH=386 go build -ldflags '' -o croc + tar -czvf croc_${{ github.event.release.name }}_NetBSD-32bit.tar.gz croc LICENSE + CGO_ENABLED=0 GOOS=netbsd GOARCH=amd64 go build -ldflags '' -o croc + tar -czvf croc_${{ github.event.release.name }}_NetBSD-64bit.tar.gz croc LICENSE + CGO_ENABLED=0 GOOS=netbsd GOARCH=arm64 go build -ldflags '' -o croc + tar -czvf croc_${{ github.event.release.name }}_NetBSD-ARM64.tar.gz croc LICENSE + CGO_ENABLED=0 GOOS=openbsd GOARCH=amd64 go build -ldflags '' -o croc + tar -czvf croc_${{ github.event.release.name }}_OpenBSD-64bit.tar.gz croc LICENSE + CGO_ENABLED=0 GOOS=openbsd GOARCH=arm64 go build -ldflags '' -o croc + tar -czvf croc_${{ github.event.release.name }}_OpenBSD-ARM64.tar.gz croc LICENSE + + - name: Setup Go + uses: actions/setup-go@v5 + with: + go-version: '1.20.7' + + - name: Build Windows 7 + run: | + go version + rm go.mod go.sum + go mod init github.com/schollz/croc/v10 + go mod tidy + CGO_ENABLED=0 GOOS=windows GOARCH=amd64 go build -ldflags '-extldflags "-static"' -o croc.exe + zip croc_${{ github.event.release.name }}_Windows7-64bit.zip croc.exe + CGO_ENABLED=0 GOOS=windows GOARCH=386 go build -ldflags '-extldflags "-static"' -o croc.exe + zip croc_${{ github.event.release.name }}_Windows7-32bit.zip croc.exe + + - name: Create checksums.txt + run: | + touch croc_${{ github.event.release.name }}_checksums.txt + sha256sum croc_${{ github.event.release.name }}_src.tar.gz >> croc_${{ github.event.release.name }}_checksums.txt + sha256sum croc_${{ github.event.release.name }}_Windows-64bit.zip >> croc_${{ github.event.release.name }}_checksums.txt + sha256sum croc_${{ github.event.release.name }}_Windows-32bit.zip >> croc_${{ github.event.release.name }}_checksums.txt + sha256sum croc_${{ github.event.release.name }}_Windows-ARM.zip >> croc_${{ github.event.release.name }}_checksums.txt + sha256sum croc_${{ github.event.release.name }}_Windows-ARM64.zip >> croc_${{ github.event.release.name }}_checksums.txt + sha256sum croc_${{ github.event.release.name }}_Windows7-64bit.zip >> croc_${{ github.event.release.name }}_checksums.txt + sha256sum croc_${{ github.event.release.name }}_Windows7-32bit.zip >> croc_${{ github.event.release.name }}_checksums.txt + sha256sum croc_${{ github.event.release.name }}_Linux-64bit.tar.gz >> croc_${{ github.event.release.name }}_checksums.txt + sha256sum croc_${{ github.event.release.name }}_Linux-32bit.tar.gz >> croc_${{ github.event.release.name }}_checksums.txt + sha256sum croc_${{ github.event.release.name }}_Linux-ARM.tar.gz >> croc_${{ github.event.release.name }}_checksums.txt + sha256sum croc_${{ github.event.release.name }}_Linux-ARMv5.tar.gz >> croc_${{ github.event.release.name }}_checksums.txt + sha256sum croc_${{ github.event.release.name }}_Linux-ARM64.tar.gz >> croc_${{ github.event.release.name }}_checksums.txt + sha256sum croc_${{ github.event.release.name }}_macOS-64bit.tar.gz >> croc_${{ github.event.release.name }}_checksums.txt + sha256sum croc_${{ github.event.release.name }}_macOS-ARM64.tar.gz >> croc_${{ github.event.release.name }}_checksums.txt + sha256sum croc_${{ github.event.release.name }}_DragonFlyBSD-64bit.tar.gz >> croc_${{ github.event.release.name }}_checksums.txt + sha256sum croc_${{ github.event.release.name }}_FreeBSD-64bit.tar.gz >> croc_${{ github.event.release.name }}_checksums.txt + sha256sum croc_${{ github.event.release.name }}_FreeBSD-ARM64.tar.gz >> croc_${{ github.event.release.name }}_checksums.txt + sha256sum croc_${{ github.event.release.name }}_NetBSD-32bit.tar.gz >> croc_${{ github.event.release.name }}_checksums.txt + sha256sum croc_${{ github.event.release.name }}_NetBSD-64bit.tar.gz >> croc_${{ github.event.release.name }}_checksums.txt + sha256sum croc_${{ github.event.release.name }}_NetBSD-ARM64.tar.gz >> croc_${{ github.event.release.name }}_checksums.txt + sha256sum croc_${{ github.event.release.name }}_OpenBSD-64bit.tar.gz >> croc_${{ github.event.release.name }}_checksums.txt + sha256sum croc_${{ github.event.release.name }}_OpenBSD-ARM64.tar.gz >> croc_${{ github.event.release.name }}_checksums.txt + + - name: Release + uses: softprops/action-gh-release@v2 + with: + files: | + croc_${{ github.event.release.name }}_checksums.txt + croc_${{ github.event.release.name }}_src.tar.gz + croc_${{ github.event.release.name }}_Windows-64bit.zip + croc_${{ github.event.release.name }}_Windows-32bit.zip + croc_${{ github.event.release.name }}_Windows-ARM.zip + croc_${{ github.event.release.name }}_Windows-ARM64.zip + croc_${{ github.event.release.name }}_Windows7-64bit.zip + croc_${{ github.event.release.name }}_Windows7-32bit.zip + croc_${{ github.event.release.name }}_Linux-64bit.tar.gz + croc_${{ github.event.release.name }}_Linux-32bit.tar.gz + croc_${{ github.event.release.name }}_Linux-ARM.tar.gz + croc_${{ github.event.release.name }}_Linux-ARMv5.tar.gz + croc_${{ github.event.release.name }}_Linux-ARM64.tar.gz + croc_${{ github.event.release.name }}_macOS-64bit.tar.gz + croc_${{ github.event.release.name }}_macOS-ARM64.tar.gz + croc_${{ github.event.release.name }}_DragonFlyBSD-64bit.tar.gz + croc_${{ github.event.release.name }}_FreeBSD-64bit.tar.gz + croc_${{ github.event.release.name }}_FreeBSD-ARM64.tar.gz + croc_${{ github.event.release.name }}_NetBSD-32bit.tar.gz + croc_${{ github.event.release.name }}_NetBSD-64bit.tar.gz + croc_${{ github.event.release.name }}_NetBSD-ARM64.tar.gz + croc_${{ github.event.release.name }}_OpenBSD-64bit.tar.gz + croc_${{ github.event.release.name }}_OpenBSD-ARM64.tar.gz From c7a2b2b9514972044b98c50cbf054f0e479caf2f Mon Sep 17 00:00:00 2001 From: blu3 Date: Fri, 31 Jan 2025 16:33:05 +0300 Subject: [PATCH 08/18] Update WinGet publish action --- .github/workflows/winget.yml | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/.github/workflows/winget.yml b/.github/workflows/winget.yml index 07b5632f..32e89195 100644 --- a/.github/workflows/winget.yml +++ b/.github/workflows/winget.yml @@ -1,13 +1,17 @@ name: Publish to Winget + on: release: types: [released] + workflow_dispatch: jobs: publish: - runs-on: ubuntu-latest + runs-on: ubuntu-24.04 + steps: - - uses: vedantmgoyal2009/winget-releaser@v2 + - name: Publish to Winget + uses: vedantmgoyal9/winget-releaser@v2 with: identifier: schollz.croc installers-regex: '_Windows-\w+\.zip$' From 2577e7a6c3b156209f57a590d811c75644a5e80e Mon Sep 17 00:00:00 2001 From: blu3 Date: Fri, 31 Jan 2025 16:33:19 +0300 Subject: [PATCH 09/18] Remove comment --- .github/FUNDING.yml | 2 -- 1 file changed, 2 deletions(-) diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml index 91b9655c..8b440473 100644 --- a/.github/FUNDING.yml +++ b/.github/FUNDING.yml @@ -1,3 +1 @@ -# These are supported funding model platforms - github: schollz From 0f978c6a2e6729d30ebe5b51aebc35a6ecd98f08 Mon Sep 17 00:00:00 2001 From: blu3 Date: Fri, 31 Jan 2025 16:34:27 +0300 Subject: [PATCH 10/18] Fix --- go.mod | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/go.mod b/go.mod index 845f0baa..398f9590 100644 --- a/go.mod +++ b/go.mod @@ -12,7 +12,7 @@ require ( github.com/magisterquis/connectproxy v0.0.0-20200725203833-3582e84f0c9b github.com/minio/highwayhash v1.0.3 github.com/sabhiram/go-gitignore v0.0.0-20210923224102-525f6e181f06 - github.com/urfave/cli v2.27.5 + github.com/urfave/cli/v2-maint v2.27.5 github.com/schollz/logger v1.2.0 github.com/schollz/pake/v3 v3.0.5 github.com/schollz/peerdiscovery v1.7.6 From 0126ce6586ee4233eb630d9aef14f0988b682262 Mon Sep 17 00:00:00 2001 From: blu3 Date: Fri, 31 Jan 2025 16:51:57 +0300 Subject: [PATCH 11/18] Better readme test --- README.md | 201 +++++++++++++++++++++++++++--------------------------- 1 file changed, 102 insertions(+), 99 deletions(-) diff --git a/README.md b/README.md index ea7f9c3d..4c06b7de 100644 --- a/README.md +++ b/README.md @@ -1,53 +1,58 @@ -

-croc -
-Version -Build -Status -

This project is supported by Github sponsors.

+ croc +
+ + Version + + + Build Status + +

+

+ This project is supported by GitHub sponsors. +

+ +## About `croc` is a tool that allows any two computers to simply and securely transfer files and folders. AFAIK, *croc* is the only CLI file-transfer tool that does **all** of the following: -- allows **any two computers** to transfer data (using a relay) -- provides **end-to-end encryption** (using PAKE) -- enables easy **cross-platform** transfers (Windows, Linux, Mac) -- allows **multiple file** transfers -- allows **resuming transfers** that are interrupted -- local server or port-forwarding **not needed** -- **ipv6-first** with ipv4 fallback -- can **use proxy**, like tor +- Allows **any two computers** to transfer data (using a relay) +- Provides **end-to-end encryption** (using PAKE) +- Enables easy **cross-platform** transfers (Windows, Linux, Mac) +- Allows **multiple file** transfers +- Allows **resuming transfers** that are interrupted +- No need for local server or port-forwarding +- **IPv6-first** with IPv4 fallback +- Can **use a proxy**, like Tor -For more information about `croc`, see [my blog post](https://schollz.com/software/croc6) or read a [recent interview I did](https://console.substack.com/p/console-91). +For more information about `croc`, see [my blog post](https://schollz.com/tinker/croc6/) or read a [recent interview I did](https://console.substack.com/p/console-91). ![Example](src/install/customization.gif) ## Install -Download [the latest release for your system](https://github.com/schollz/croc/releases/latest), or install a release from the command-line: +You can download [the latest release for your system](https://github.com/schollz/croc/releases/latest), or install a release from the command-line: -``` +```bash curl https://getcroc.schollz.com | bash ``` +### On macOS -On macOS you can install the latest release with [Homebrew](https://brew.sh/): +Using [Homebrew](https://brew.sh/): + ```bash + brew install croc + ``` -``` -brew install croc -``` +Using [MacPorts](https://www.macports.org/): + ```bash + sudo port selfupdate + sudo port install croc + ``` -On macOS you can also install the latest release with [MacPorts](https://macports.org/): +### On Windows -``` -sudo port selfupdate -sudo port install croc -``` - -On Windows you can install the latest release with [Scoop](https://scoop.sh/), [Chocolatey](https://chocolatey.org), or [Winget](https://learn.microsoft.com/en-us/windows/package-manager/): +You can install the latest release with [Scoop](https://scoop.sh/), [Chocolatey](https://chocolatey.org/), or [Winget](https://learn.microsoft.com/windows/package-manager/): ```bash scoop install croc @@ -61,74 +66,92 @@ choco install croc winget install schollz.croc ``` -On Unix you can install the latest release with [Nix](https://nixos.org/nix): +### On Unix + +You can install the latest release with [Nix](https://nixos.org/): ```bash nix-env -i croc ``` +### On Alpine Linux -On Alpine Linux you have to install dependencies first: +First, install dependencies: ```bash apk add bash coreutils wget -qO- https://getcroc.schollz.com | bash ``` -On Arch Linux you can install the latest release with `pacman`: +### On Arch Linux + +Install with `pacman`: ```bash pacman -S croc ``` -On Fedora you can install with `dnf`: +### On Fedora + +Install with `dnf`: ```bash dnf install croc ``` -On Gentoo you can install with `portage`: +### On Gentoo + +Install with `portage`: ```bash emerge net-misc/croc ``` -On Termux you can install with `pkg`: +### On Termux + +Install with `pkg`: ```bash pkg install croc ``` -On FreeBSD you can install with `pkg`: +### On FreeBSD + +Install with `pkg`: ```bash pkg install croc ``` -On Linux, macOS, and Windows you can install from [conda-forge](https://github.com/conda-forge/croc-feedstock/) globally with [`pixi`](https://pixi.sh/): +### On Linux, macOS, and Windows via Conda + +You can install from [conda-forge](https://github.com/conda-forge/croc-feedstock) globally with [`pixi`](https://pixi.sh/): ```bash pixi global install croc ``` -or into a particular environment with [`conda`](https://docs.conda.io/projects/conda/): +Or install into a particular environment with [`conda`](https://docs.conda.io/projects/conda/): ```bash conda install --channel conda-forge croc ``` -Or, you can [install Go](https://golang.org/dl/) and build from source (requires Go 1.17+): +### Build from Source + +If you prefer, you can [install Go](https://go.dev/dl/) and build from source (requires Go 1.17+): ```bash go install github.com/schollz/croc/v10@latest ``` -On Android there is a 3rd party F-Droid app [available to download](https://f-droid.org/en/packages/com.github.howeyc.crocgui/). +### On Android +There is a 3rd-party F-Droid app [available to download](https://f-droid.org/packages/com.github.howeyc.crocgui/). ## Usage -To send a file, simply do: +To send a file, simply do: ```bash $ croc send [file(s)-or-folder] @@ -136,62 +159,55 @@ Sending 'file-or-folder' (X MB) Code is: code-phrase ``` -Then to receive the file (or folder) on another computer, you can just do +Then, to receive the file (or folder) on another computer, run: -``` +```bash croc code-phrase ``` The code phrase is used to establish password-authenticated key agreement ([PAKE](https://en.wikipedia.org/wiki/Password-authenticated_key_agreement)) which generates a secret key for the sender and recipient to use for end-to-end encryption. -There are a number of configurable options (see `--help`). A set of options (like custom relay, ports, and code phrase) can be set using `--remember`. +### Customizations & Options -### Using `croc` on Linux or Mac OS +#### Using `croc` on Linux or macOS -On Linux and Mac OS, the sending & receiving is slightly different to avoid [leaking the secret via the process name](https://nvd.nist.gov/vuln/detail/CVE-2023-43621). On these systems you will need to run `croc` with the secret as an environment variable. For example, to receive with the secret `***`: +On Linux and macOS, the sending and receiving process is slightly different to avoid [leaking the secret via the process name](https://nvd.nist.gov/vuln/detail/CVE-2023-43621). You will need to run `croc` with the secret as an environment variable. For example, to receive with the secret `***`: ```bash CROC_SECRET=*** croc ``` -This will show only `croc` in the process list of a multi-user system and not leak the secret. - -For a single-user system the default behavior can be permanently enabled by running +For single-user systems, the default behavior can be permanently enabled by running: ```bash croc --classic ``` -and confirming. -Run this command again to disable classic mode. +#### Custom Code Phrase -### Custom code phrase - -You can send with your own code phrase (must be more than 6 characters). +You can send with your own code phrase (must be more than 6 characters): ```bash croc send --code [code-phrase] [file(s)-or-folder] ``` -### Allow overwriting without prompt +#### Allow Overwriting Without Prompt -By default, croc will prompt whether to overwrite a file. You can automatically overwrite files by using the `--overwrite` flag (recipient only). For example, receive a file to automatically overwrite: +To automatically overwrite files without prompting, use the `--overwrite` flag: ```bash croc --yes --overwrite ``` -### Excluding folders +#### Excluding Folders -You can exclude folders from being sent by using the `--exclude` flag with a string of comma-delimited exclusions. For example, if you want to send a folder but exclude any `node_modules` folders or `.venv` folders: +To exclude folders from being sent, use the `--exclude` flag with comma-delimited exclusions: ```bash croc send --exclude "node_modules,.venv" [folder] ``` -Exclusions work by excluding any absolute path that contains the string. So in the above example, any folder named `node_modules` or `.venv` will be excluded from the transfer. - -### Use pipes - stdin and stdout +#### Use Pipes - stdin and stdout You can pipe to `croc`: @@ -199,93 +215,80 @@ You can pipe to `croc`: cat [filename] | croc send ``` -In this case `croc` will automatically use the stdin data and send and assign a filename like "croc-stdin-123456789". To receive to `stdout` at you can always just use the `--yes` will automatically approve the transfer and pipe it out to `stdout`. +To receive the file to `stdout`, you can use: ```bash croc --yes [code-phrase] > out ``` -All of the other text printed to the console is going to `stderr` so it will not interfere with the message going to `stdout`. +#### Send Text - -### Send text - -Sometimes you want to send URLs or short text. In addition to piping, you can easily send text with `croc`: +To send URLs or short text, use: ```bash croc send --text "hello world" ``` -This will automatically tell the receiver to use `stdout` when they receive the text so it will be displayed. +#### Use a Proxy - -### Use a proxy - -You can use a proxy as your connection to the relay by adding a proxy address with `--socks5`. For example, you can send via a tor relay: +You can send files via a proxy by adding `--socks5`: ```bash croc --socks5 "127.0.0.1:9050" send SOMEFILE ``` -### Change encryption curve +#### Change Encryption Curve -You can choose from several different elliptic curves to use for encryption by using the `--curve` flag. Only the recipient can choose the curve. For example, receive a file using the P-521 curve: +To choose a different elliptic curve for encryption, use the `--curve` flag: ```bash croc --curve p521 ``` -Available curves are P-256, P-348, P-521 and SIEC. P-256 is the default curve. +#### Change Hash Algorithm -### Change hash algorithm - -You can choose from several different hash algorithms. The default is the `xxhash` algorithm which is fast and thorough. If you want to optimize for speed you can use the `imohash` algorithm which is even faster, but since it samples files (versus reading the whole file) it can mistakenly determine that a file is the same on the two computers transferring - though this is only a problem if you are syncing files versus sending a new file to a computer. +For faster hashing, use the `imohash` algorithm: ```bash croc send --hash imohash SOMEFILE ``` -### Self-host relay +#### Self-host Relay -The relay is needed to staple the parallel incoming and outgoing connections. By default, `croc` uses a public relay but you can also run your own relay: +You can run your own relay: ```bash croc relay ``` -By default it uses TCP ports 9009-9013. Make sure to open those up. You can customize the ports (e.g. `croc relay --ports 1111,1112`), but you must have a minimum of **2** ports for the relay. The first port is for communication and the subsequent ports are used for the multiplexed data transfer. +By default, it uses TCP ports 9009-9013. You can customize the ports (e.g., `croc relay --ports 1111,1112`), but at least **2** ports are required. -You can send files using your relay by entering `--relay` to change the relay that you are using if you want to custom host your own. +To send files using your relay: ```bash croc --relay "myrelay.example.com:9009" send [filename] ``` -Note, when sending, you only need to include the first port (the communication port). The subsequent ports for data transfer will be transmitted back to the user from the relay. - -#### Self-host relay (docker) - -If it's easier you can also run a relay with Docker: +#### Self-host Relay with Docker +You can also run a relay with Docker: ```bash docker run -d -p 9009-9013:9009-9013 -e CROC_PASS='YOURPASSWORD' schollz/croc ``` -Be sure to include the password for the relay otherwise any requests will be rejected. +To send files using your custom relay: ```bash croc --pass YOURPASSWORD --relay "myreal.example.com:9009" send [filename] ``` -Note: when including `--pass YOURPASSWORD` you can instead pass a file with the password, e.g. `--pass FILEWITHPASSWORD`. - -## License - -MIT - ## Acknowledgements -`croc` has gone through many iterations, and I am awed by all the great contributions! If you feel like contributing, in any way, by all means you can send an Issue, a PR, or ask a question. +`croc` has evolved through many iterations, and I am thankful for the contributions! Special thanks to: -Thanks [@warner](https://github.com/warner) for the [idea](https://github.com/warner/magic-wormhole), [@tscholl2](https://github.com/tscholl2) for the [encryption gists](https://gist.github.com/tscholl2/dc7dc15dc132ea70a98e8542fefffa28), [@skorokithakis](https://github.com/skorokithakis) for [code on proxying two connections](https://www.stavros.io/posts/proxying-two-connections-go/). Finally thanks for making pull requests [@maximbaz](https://github.com/maximbaz), [@meyermarcel](https://github.com/meyermarcel), [@Girbons](https://github.com/Girbons), [@techtide](https://github.com/techtide), [@heymatthew](https://github.com/heymatthew), [@Lunsford94](https://github.com/Lunsford94), [@lummie](https://github.com/lummie), [@jesuiscamille](https://github.com/jesuiscamille), [@threefjord](https://github.com/threefjord), [@marcossegovia](https://github.com/marcossegovia), [@csleong98](https://github.com/csleong98), [@afotescu](https://github.com/afotescu), [@callmefever](https://github.com/callmefever), [@El-JojA](https://github.com/El-JojA), [@anatolyyyyyy](https://github.com/anatolyyyyyy), [@goggle](https://github.com/goggle), [@smileboywtu](https://github.com/smileboywtu), [@nicolashardy](https://github.com/nicolashardy), [@fbartels](https://github.com/fbartels), [@rkuprov](https://github.com/rkuprov), [@hreese](https://github.com/hreese), [@xenrox](https://github.com/xenrox) and [Ipar](https://github.com/lpar)! +- [@warner](https://github.com/warner) for the [idea](https://github.com/magic-wormhole/magic-wormhole) +- [@tscholl2](https://github.com/tscholl2) for the [encryption gists](https://gist.github.com/tscholl2/dc7dc15dc132ea70a98e8542fefffa28) +- [@skorokithakis](https://github.com/skorokithakis) for [proxying two connections](https://www.stavros.io/posts/proxying-two-connections-go/) + +And many more! From 3f8c75e49ee002409ffe344ee37c8d45cb304b26 Mon Sep 17 00:00:00 2001 From: blu3 Date: Fri, 31 Jan 2025 16:54:24 +0300 Subject: [PATCH 12/18] Fix a few mistakes --- README.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 4c06b7de..cfcd0d8d 100644 --- a/README.md +++ b/README.md @@ -40,15 +40,15 @@ curl https://getcroc.schollz.com | bash ### On macOS Using [Homebrew](https://brew.sh/): - ```bash - brew install croc - ``` +```bash +brew install croc +``` Using [MacPorts](https://www.macports.org/): - ```bash - sudo port selfupdate - sudo port install croc - ``` +```bash +sudo port selfupdate +sudo port install croc +``` ### On Windows @@ -139,7 +139,7 @@ conda install --channel conda-forge croc ### Build from Source -If you prefer, you can [install Go](https://go.dev/dl/) and build from source (requires Go 1.17+): +If you prefer, you can [install Go](https://go.dev/dl/) and build from source (requires Go 1.22+): ```bash go install github.com/schollz/croc/v10@latest From e0099464e7d7e979555b02db36fc2389dd6b916d Mon Sep 17 00:00:00 2001 From: blu3 Date: Fri, 31 Jan 2025 16:56:37 +0300 Subject: [PATCH 13/18] Revert the change here --- go.mod | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/go.mod b/go.mod index 398f9590..b0d9c503 100644 --- a/go.mod +++ b/go.mod @@ -12,7 +12,7 @@ require ( github.com/magisterquis/connectproxy v0.0.0-20200725203833-3582e84f0c9b github.com/minio/highwayhash v1.0.3 github.com/sabhiram/go-gitignore v0.0.0-20210923224102-525f6e181f06 - github.com/urfave/cli/v2-maint v2.27.5 + github.com/schollz/cli/v2 v2.2.1 github.com/schollz/logger v1.2.0 github.com/schollz/pake/v3 v3.0.5 github.com/schollz/peerdiscovery v1.7.6 From f12b7f7a9359b4aeb7e58ff91ef23ab0d051cb47 Mon Sep 17 00:00:00 2001 From: blu3 Date: Fri, 31 Jan 2025 16:56:48 +0300 Subject: [PATCH 14/18] Fixup docker --- Dockerfile | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Dockerfile b/Dockerfile index fed684b7..3f223534 100644 --- a/Dockerfile +++ b/Dockerfile @@ -1,4 +1,4 @@ -FROM golang:1.22-alpine as builder +FROM golang:1.23-alpine as builder RUN apk add --no-cache git gcc musl-dev WORKDIR /go/croc COPY . . From e9a95b984d4268005d96314e52f0dfd440fec189 Mon Sep 17 00:00:00 2001 From: blu3 Date: Fri, 31 Jan 2025 16:57:16 +0300 Subject: [PATCH 15/18] Some formatting --- .travis.yml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/.travis.yml b/.travis.yml index fe3829d9..3870f28c 100644 --- a/.travis.yml +++ b/.travis.yml @@ -16,8 +16,8 @@ script: - env GO111MODULE=on go test -v -cover github.com/schollz/croc/v10/src/tcp - env GO111MODULE=on go test -v -cover github.com/schollz/croc/v10/src/utils - env GO111MODULE=on go test -v -cover github.com/schollz/croc/v10/src/comm - + branches: except: - - dev - - win + - dev + - win From 97fdb3475ba69e9dde5ecd0615f57d3692d3e098 Mon Sep 17 00:00:00 2001 From: blu3 Date: Fri, 31 Jan 2025 16:59:19 +0300 Subject: [PATCH 16/18] Update goreleaser props --- .goreleaser.yml | 18 ++++++++---------- 1 file changed, 8 insertions(+), 10 deletions(-) diff --git a/.goreleaser.yml b/.goreleaser.yml index e36cd99f..1bad13cf 100644 --- a/.goreleaser.yml +++ b/.goreleaser.yml @@ -1,4 +1,5 @@ project_name: croc + build: main: main.go binary: croc @@ -25,9 +26,9 @@ build: goarch: arm goarm: - 7 + nfpms: - - - formats: + - formats: - deb vendor: "schollz.com" homepage: "https://schollz.com/software/croc/" @@ -47,9 +48,9 @@ nfpms: netbsd: NetBSD freebsd: FreeBSD dragonfly: DragonFlyBSD + archives: - - - format: tar.gz + - format: tar.gz format_overrides: - goos: windows format: zip @@ -73,8 +74,7 @@ archives: - bash_autocomplete brews: - - - tap: + - tap: owner: schollz name: homebrew-tap folder: Formula @@ -82,7 +82,6 @@ brews: homepage: "https://schollz.com/software/croc/" install: | bin.install "croc" - test: | system "#{bin}/croc --version" @@ -93,8 +92,7 @@ scoop: homepage: "https://schollz.com/software/croc/" description: "croc is a tool that allows any two computers to simply and securely transfer files and folders." license: MIT + announce: twitter: - # Wether its enabled or not. - # Defaults to false. - enabled: false \ No newline at end of file + enabled: false From 68dbe8d04f4327246744dea47d59a1e19ead06c7 Mon Sep 17 00:00:00 2001 From: blu3 Date: Fri, 31 Jan 2025 17:00:18 +0300 Subject: [PATCH 17/18] add some spaces --- Dockerfile | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/Dockerfile b/Dockerfile index 3f223534..ee1e12c4 100644 --- a/Dockerfile +++ b/Dockerfile @@ -1,16 +1,24 @@ FROM golang:1.23-alpine as builder + RUN apk add --no-cache git gcc musl-dev + WORKDIR /go/croc + COPY . . + RUN go build -v -ldflags="-s -w" FROM alpine:latest + EXPOSE 9009 EXPOSE 9010 EXPOSE 9011 EXPOSE 9012 EXPOSE 9013 + COPY --from=builder /go/croc/croc /go/croc/croc-entrypoint.sh / + USER nobody + ENTRYPOINT ["/croc-entrypoint.sh"] CMD ["relay"] From 7a2ddc31b6725b2cf80999fd54e5374039ac9ba2 Mon Sep 17 00:00:00 2001 From: blu3 Date: Fri, 31 Jan 2025 17:00:42 +0300 Subject: [PATCH 18/18] add spaces --- croc-entrypoint.sh | 2 ++ 1 file changed, 2 insertions(+) diff --git a/croc-entrypoint.sh b/croc-entrypoint.sh index c0350286..9d217f64 100755 --- a/croc-entrypoint.sh +++ b/croc-entrypoint.sh @@ -1,6 +1,8 @@ #!/bin/sh set -e + if [ -n "$CROC_PASS" ]; then set -- --pass "$CROC_PASS" "$@" fi + exec /croc "$@"