mirrors_public/schollz_croc
1
1
Fork 0
mirror of https://github.com/schollz/croc.git synced 2025-10-11 13:21:00 +02:00
Code Activity

Merge pull request #881 from blu3berryys/main

Browse source 
Bump Go, dependencies, CI - Upload artifacts after running tests - Update readme
This commit is contained in:
Zack 2025-01-31 07:05:15 -08:00 • committed by GitHub
commit cb802bae91
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
14 changed files with 366 additions and 336 deletions
Download patch file Download diff file Expand all files Collapse all files

2
.github/FUNDING.yml vendored
View file

@ -1,3 +1 @@
# These are supported funding model platforms
github: schollz github: schollz

104
.github/workflows/ci.yml vendored
View file

@ -1,52 +1,70 @@
name: CI name: CI
on: on:
push: push:
branches: [main]
pull_request: pull_request:
branches: [main] workflow_dispatch:
jobs: jobs:
unit-tests: unit-tests:
name: Go unit tests name: Go unit tests
runs-on: ubuntu-latest runs-on: ubuntu-24.04
steps: steps:
- uses: actions/checkout@v4 - name: Checkout repository
- uses: actions/setup-go@v5 uses: actions/checkout@v4
with:
go-version: '1.23' - name: Setup Go
- run: go version uses: actions/setup-go@v5
- run: go test -v ./... with:
- name: Build files go-version: '^1.23.5'
run: |
go version - name: Display Go version
CGO_ENABLED=0 GOOS=windows GOARCH=amd64 go build -ldflags '-extldflags "-static"' -o croc.exe run: go version
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 - name: Run unit tests
CGO_ENABLED=0 GOOS=windows GOARCH=arm64 go build -ldflags '-extldflags "-static"' -o croc.exe run: go test -v ./...
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 - name: Build files
CGO_ENABLED=0 GOOS=linux GOARCH=arm go build -ldflags '-extldflags "-static"' -o croc run: |
GOARM=5 CGO_ENABLED=0 GOOS=linux GOARCH=arm go build -ldflags '-extldflags "-static"' -o croc go version
CGO_ENABLED=0 GOOS=linux GOARCH=arm64 go build -ldflags '-extldflags "-static"' -o croc CGO_ENABLED=0 GOOS=windows GOARCH=amd64 go build -ldflags '-extldflags "-static"' -o croc-windows-amd64.exe
CGO_ENABLED=0 GOOS=darwin GOARCH=amd64 go build -ldflags '-s -extldflags "-sectcreate __TEXT __info_plist Info.plist"' -o croc CGO_ENABLED=0 GOOS=windows GOARCH=386 go build -ldflags '-extldflags "-static"' -o croc-windows-386.exe
CGO_ENABLED=0 GOOS=darwin GOARCH=arm64 go build -ldflags '-s -extldflags "-sectcreate __TEXT __info_plist Info.plist"' -o croc CGO_ENABLED=0 GOOS=windows GOARCH=arm go build -ldflags '-extldflags "-static"' -o croc-windows-arm.exe
CGO_ENABLED=0 GOOS=dragonfly GOARCH=amd64 go build -ldflags '' -o croc CGO_ENABLED=0 GOOS=windows GOARCH=arm64 go build -ldflags '-extldflags "-static"' -o croc-windows-arm64.exe
CGO_ENABLED=0 GOOS=freebsd GOARCH=amd64 go build -ldflags '' -o croc CGO_ENABLED=0 GOOS=linux GOARCH=amd64 go build -ldflags '-extldflags "-static"' -o croc-linux-amd64
CGO_ENABLED=0 GOOS=freebsd GOARCH=arm64 go build -ldflags '' -o croc CGO_ENABLED=0 GOOS=linux GOARCH=386 go build -ldflags '-extldflags "-static"' -o croc-linux-386
CGO_ENABLED=0 GOOS=netbsd GOARCH=386 go build -ldflags '' -o croc CGO_ENABLED=0 GOOS=linux GOARCH=arm go build -ldflags '-extldflags "-static"' -o croc-linux-arm
CGO_ENABLED=0 GOOS=netbsd GOARCH=amd64 go build -ldflags '' -o croc GOARM=5 CGO_ENABLED=0 GOOS=linux GOARCH=arm go build -ldflags '-extldflags "-static"' -o croc-linux-arm5
CGO_ENABLED=0 GOOS=netbsd GOARCH=arm64 go build -ldflags '' -o croc CGO_ENABLED=0 GOOS=linux GOARCH=arm64 go build -ldflags '-extldflags "-static"' -o croc-linux-arm64
CGO_ENABLED=0 GOOS=openbsd GOARCH=amd64 go build -ldflags '' -o croc 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=openbsd GOARCH=arm64 go build -ldflags '' -o croc CGO_ENABLED=0 GOOS=darwin GOARCH=arm64 go build -ldflags '-s -extldflags "-sectcreate __TEXT __info_plist Info.plist"' -o croc-darwin-arm64
- name: Setup Go CGO_ENABLED=0 GOOS=freebsd GOARCH=amd64 go build -ldflags '' -o croc-freebsd-amd64
uses: actions/setup-go@v5 CGO_ENABLED=0 GOOS=freebsd GOARCH=arm64 go build -ldflags '' -o croc-freebsd-arm64
with: CGO_ENABLED=0 GOOS=openbsd GOARCH=amd64 go build -ldflags '' -o croc-openbsd-amd64
go-version: '1.20.7' # go1.20.8+ refuses to build go1.22 code... CGO_ENABLED=0 GOOS=openbsd GOARCH=arm64 go build -ldflags '' -o croc-openbsd-arm64
- name: Build Windows 7
run: | - name: Setup Go for Windows 7 Build
go version uses: actions/setup-go@v5
rm go.mod go.sum with:
go mod init github.com/schollz/croc/v10 go-version: '1.20.7' # Go 1.20.8+ refuses to build Go 1.23 code
go mod tidy
CGO_ENABLED=0 GOOS=windows GOARCH=amd64 go build -ldflags '-extldflags "-static"' -o croc.exe - name: Build Windows 7 version
CGO_ENABLED=0 GOOS=windows GOARCH=386 go build -ldflags '-extldflags "-static"' -o croc.exe 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

43
.github/workflows/deploy.yml vendored
View file

@ -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: on:
# Triggers the workflow on push or pull request events but only for the main branch
push: push:
branches:
- '*'
tags:
- 'v*'
pull_request: pull_request:
branches:
- '*'
# Allows you to run this workflow manually from the Actions tab
workflow_dispatch: workflow_dispatch:
# A workflow run is made up of one or more jobs that can run sequentially or in parallel
jobs: jobs:
docker: docker:
runs-on: ubuntu-latest runs-on: ubuntu-24.04
steps: steps:
- - name: Checkout repository
name: Checkout
uses: actions/checkout@v4 uses: actions/checkout@v4
-
name: Docker meta - name: Docker meta
id: docker_meta id: meta
uses: docker/metadata-action@v5 uses: docker/metadata-action@v5
with: with:
images: schollz/croc images: schollz/croc
# generate Docker tags based on the following events/attributes
tags: | tags: |
type=ref,event=branch type=ref,event=branch
type=ref,event=pr type=ref,event=pr
@ -39,21 +24,21 @@ jobs:
type=semver,pattern={{major}}.{{minor}} type=semver,pattern={{major}}.{{minor}}
type=semver,pattern={{major}} type=semver,pattern={{major}}
type=sha type=sha
-
name: Set up QEMU - name: Setup QEMU
uses: docker/setup-qemu-action@v3 uses: docker/setup-qemu-action@v3
-
name: Set up Docker Buildx - name: Set up Docker Buildx
uses: docker/setup-buildx-action@v3 uses: docker/setup-buildx-action@v3
-
name: Login to DockerHub - name: Login to DockerHub
if: github.event_name != 'pull_request' if: github.event_name != 'pull_request'
uses: docker/login-action@v3 uses: docker/login-action@v3
with: with:
username: ${{ secrets.DOCKERHUB_USERNAME }} username: ${{ secrets.DOCKERHUB_USERNAME }}
password: ${{ secrets.DOCKERHUB_TOKEN }} password: ${{ secrets.DOCKERHUB_TOKEN }}
-
name: Build and push - name: Build and push
uses: docker/build-push-action@v6 uses: docker/build-push-action@v6
with: with:
context: . context: .

245
.github/workflows/release.yml vendored
View file

@ -1,4 +1,4 @@
name: Make release name: Release
on: on:
release: release:
@ -10,122 +10,129 @@ permissions:
jobs: jobs:
build: build:
runs-on: ubuntu-latest runs-on: ubuntu-24.04
steps: steps:
- name: Checkout project - name: Checkout repository
uses: actions/checkout@v4 uses: actions/checkout@v4
- name: Setup Go
uses: actions/setup-go@v4 - name: Setup Go
with: uses: actions/setup-go@v5
go-version: '1.23' with:
- name: Prepare source tarball go-version: '^1.23.5'
run: |
git clone -b ${{ github.event.release.name }} --depth 1 https://github.com/schollz/croc croc-${{ github.event.release.name }} - name: Prepare source tarball
cd croc-${{ github.event.release.name }} && go mod tidy && go mod vendor run: |
cd .. && tar -czvf croc_${{ github.event.release.name }}_src.tar.gz croc-${{ github.event.release.name }} git clone -b ${{ github.event.release.name }} --depth 1 https://github.com/schollz/croc croc-${{ github.event.release.name }}
- name: Build files cd croc-${{ github.event.release.name }} && go mod tidy && go mod vendor
run: | cd .. && tar -czvf croc_${{ github.event.release.name }}_src.tar.gz croc-${{ github.event.release.name }}
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 - name: Build files
CGO_ENABLED=0 GOOS=windows GOARCH=386 go build -ldflags '-extldflags "-static"' -o croc.exe run: |
zip croc_${{ github.event.release.name }}_Windows-32bit.zip croc.exe LICENSE CGO_ENABLED=0 GOOS=windows GOARCH=amd64 go build -ldflags '-extldflags "-static"' -o croc.exe
CGO_ENABLED=0 GOOS=windows GOARCH=arm go build -ldflags '-extldflags "-static"' -o croc.exe zip croc_${{ github.event.release.name }}_Windows-64bit.zip croc.exe LICENSE
zip croc_${{ github.event.release.name }}_Windows-ARM.zip croc.exe LICENSE CGO_ENABLED=0 GOOS=windows GOARCH=386 go build -ldflags '-extldflags "-static"' -o croc.exe
CGO_ENABLED=0 GOOS=windows GOARCH=arm64 go build -ldflags '-extldflags "-static"' -o croc.exe zip croc_${{ github.event.release.name }}_Windows-32bit.zip croc.exe LICENSE
zip croc_${{ github.event.release.name }}_Windows-ARM64.zip croc.exe LICENSE CGO_ENABLED=0 GOOS=windows GOARCH=arm go build -ldflags '-extldflags "-static"' -o croc.exe
CGO_ENABLED=0 GOOS=linux GOARCH=amd64 go build -ldflags '-extldflags "-static"' -o croc zip croc_${{ github.event.release.name }}_Windows-ARM.zip croc.exe LICENSE
tar -czvf croc_${{ github.event.release.name }}_Linux-64bit.tar.gz croc LICENSE CGO_ENABLED=0 GOOS=windows GOARCH=arm64 go build -ldflags '-extldflags "-static"' -o croc.exe
CGO_ENABLED=0 GOOS=linux GOARCH=386 go build -ldflags '-extldflags "-static"' -o croc zip croc_${{ github.event.release.name }}_Windows-ARM64.zip croc.exe LICENSE
tar -czvf croc_${{ github.event.release.name }}_Linux-32bit.tar.gz croc LICENSE CGO_ENABLED=0 GOOS=linux GOARCH=amd64 go build -ldflags '-extldflags "-static"' -o croc
CGO_ENABLED=0 GOOS=linux GOARCH=arm go build -ldflags '-extldflags "-static"' -o croc tar -czvf croc_${{ github.event.release.name }}_Linux-64bit.tar.gz croc LICENSE
tar -czvf croc_${{ github.event.release.name }}_Linux-ARM.tar.gz croc LICENSE CGO_ENABLED=0 GOOS=linux GOARCH=386 go build -ldflags '-extldflags "-static"' -o croc
GOARM=5 CGO_ENABLED=0 GOOS=linux GOARCH=arm go build -ldflags '-extldflags "-static"' -o croc tar -czvf croc_${{ github.event.release.name }}_Linux-32bit.tar.gz croc LICENSE
tar -czvf croc_${{ github.event.release.name }}_Linux-ARMv5.tar.gz croc LICENSE 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 tar -czvf croc_${{ github.event.release.name }}_Linux-ARM.tar.gz croc LICENSE
tar -czvf croc_${{ github.event.release.name }}_Linux-ARM64.tar.gz croc LICENSE GOARM=5 CGO_ENABLED=0 GOOS=linux GOARCH=arm 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 tar -czvf croc_${{ github.event.release.name }}_Linux-ARMv5.tar.gz croc LICENSE
tar -czvf croc_${{ github.event.release.name }}_macOS-64bit.tar.gz croc LICENSE CGO_ENABLED=0 GOOS=linux GOARCH=arm64 go build -ldflags '-extldflags "-static"' -o croc
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 }}_Linux-ARM64.tar.gz croc LICENSE
tar -czvf croc_${{ github.event.release.name }}_macOS-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
CGO_ENABLED=0 GOOS=dragonfly GOARCH=amd64 go build -ldflags '' -o croc tar -czvf croc_${{ github.event.release.name }}_macOS-64bit.tar.gz croc LICENSE
tar -czvf croc_${{ github.event.release.name }}_DragonFlyBSD-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
CGO_ENABLED=0 GOOS=freebsd GOARCH=amd64 go build -ldflags '' -o croc tar -czvf croc_${{ github.event.release.name }}_macOS-ARM64.tar.gz croc LICENSE
tar -czvf croc_${{ github.event.release.name }}_FreeBSD-64bit.tar.gz croc LICENSE CGO_ENABLED=0 GOOS=dragonfly GOARCH=amd64 go build -ldflags '' -o croc
CGO_ENABLED=0 GOOS=freebsd GOARCH=arm64 go build -ldflags '' -o croc tar -czvf croc_${{ github.event.release.name }}_DragonFlyBSD-64bit.tar.gz croc LICENSE
tar -czvf croc_${{ github.event.release.name }}_FreeBSD-ARM64.tar.gz croc LICENSE CGO_ENABLED=0 GOOS=freebsd GOARCH=amd64 go build -ldflags '' -o croc
CGO_ENABLED=0 GOOS=netbsd GOARCH=386 go build -ldflags '' -o croc tar -czvf croc_${{ github.event.release.name }}_FreeBSD-64bit.tar.gz croc LICENSE
tar -czvf croc_${{ github.event.release.name }}_NetBSD-32bit.tar.gz croc LICENSE CGO_ENABLED=0 GOOS=freebsd GOARCH=arm64 go build -ldflags '' -o croc
CGO_ENABLED=0 GOOS=netbsd GOARCH=amd64 go build -ldflags '' -o croc tar -czvf croc_${{ github.event.release.name }}_FreeBSD-ARM64.tar.gz croc LICENSE
tar -czvf croc_${{ github.event.release.name }}_NetBSD-64bit.tar.gz croc LICENSE CGO_ENABLED=0 GOOS=netbsd GOARCH=386 go build -ldflags '' -o croc
CGO_ENABLED=0 GOOS=netbsd GOARCH=arm64 go build -ldflags '' -o croc tar -czvf croc_${{ github.event.release.name }}_NetBSD-32bit.tar.gz croc LICENSE
tar -czvf croc_${{ github.event.release.name }}_NetBSD-ARM64.tar.gz croc LICENSE CGO_ENABLED=0 GOOS=netbsd GOARCH=amd64 go build -ldflags '' -o croc
CGO_ENABLED=0 GOOS=openbsd GOARCH=amd64 go build -ldflags '' -o croc tar -czvf croc_${{ github.event.release.name }}_NetBSD-64bit.tar.gz croc LICENSE
tar -czvf croc_${{ github.event.release.name }}_OpenBSD-64bit.tar.gz croc LICENSE CGO_ENABLED=0 GOOS=netbsd GOARCH=arm64 go build -ldflags '' -o croc
CGO_ENABLED=0 GOOS=openbsd GOARCH=arm64 go build -ldflags '' -o croc tar -czvf croc_${{ github.event.release.name }}_NetBSD-ARM64.tar.gz croc LICENSE
tar -czvf croc_${{ github.event.release.name }}_OpenBSD-ARM64.tar.gz croc LICENSE CGO_ENABLED=0 GOOS=openbsd GOARCH=amd64 go build -ldflags '' -o croc
- name: Setup Go tar -czvf croc_${{ github.event.release.name }}_OpenBSD-64bit.tar.gz croc LICENSE
uses: actions/setup-go@v5 CGO_ENABLED=0 GOOS=openbsd GOARCH=arm64 go build -ldflags '' -o croc
with: tar -czvf croc_${{ github.event.release.name }}_OpenBSD-ARM64.tar.gz croc LICENSE
go-version: '1.20.7' # go1.20.8+ refuses to build go1.22 code...
- name: Build Windows 7 - name: Setup Go
run: | uses: actions/setup-go@v5
go version with:
rm go.mod go.sum go-version: '1.20.7'
go mod init github.com/schollz/croc/v10
go mod tidy - name: Build Windows 7
CGO_ENABLED=0 GOOS=windows GOARCH=amd64 go build -ldflags '-extldflags "-static"' -o croc.exe run: |
zip croc_${{ github.event.release.name }}_Windows7-64bit.zip croc.exe go version
CGO_ENABLED=0 GOOS=windows GOARCH=386 go build -ldflags '-extldflags "-static"' -o croc.exe rm go.mod go.sum
zip croc_${{ github.event.release.name }}_Windows7-32bit.zip croc.exe go mod init github.com/schollz/croc/v10
- name: Create checksums.txt go mod tidy
run: | CGO_ENABLED=0 GOOS=windows GOARCH=amd64 go build -ldflags '-extldflags "-static"' -o croc.exe
touch croc_${{ github.event.release.name }}_checksums.txt zip croc_${{ github.event.release.name }}_Windows7-64bit.zip croc.exe
sha256sum croc_${{ github.event.release.name }}_src.tar.gz >> croc_${{ github.event.release.name }}_checksums.txt CGO_ENABLED=0 GOOS=windows GOARCH=386 go build -ldflags '-extldflags "-static"' -o croc.exe
sha256sum croc_${{ github.event.release.name }}_Windows-64bit.zip >> croc_${{ github.event.release.name }}_checksums.txt zip croc_${{ github.event.release.name }}_Windows7-32bit.zip croc.exe
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 - name: Create checksums.txt
sha256sum croc_${{ github.event.release.name }}_Windows-ARM64.zip >> croc_${{ github.event.release.name }}_checksums.txt run: |
sha256sum croc_${{ github.event.release.name }}_Windows7-64bit.zip >> croc_${{ github.event.release.name }}_checksums.txt touch 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 }}_src.tar.gz >> 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 }}_Windows-64bit.zip >> 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 }}_Windows-32bit.zip >> 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 }}_Windows-ARM.zip >> 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 }}_Windows-ARM64.zip >> 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 }}_Windows7-64bit.zip >> 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 }}_Windows7-32bit.zip >> 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 }}_Linux-64bit.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 }}_Linux-32bit.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 }}_Linux-ARM.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 }}_Linux-ARMv5.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 }}_Linux-ARM64.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 }}_macOS-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 }}_macOS-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 }}_DragonFlyBSD-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 sha256sum croc_${{ github.event.release.name }}_FreeBSD-64bit.tar.gz >> croc_${{ github.event.release.name }}_checksums.txt
- name: Release sha256sum croc_${{ github.event.release.name }}_FreeBSD-ARM64.tar.gz >> croc_${{ github.event.release.name }}_checksums.txt
uses: softprops/action-gh-release@v2 sha256sum croc_${{ github.event.release.name }}_NetBSD-32bit.tar.gz >> croc_${{ github.event.release.name }}_checksums.txt
with: sha256sum croc_${{ github.event.release.name }}_NetBSD-64bit.tar.gz >> croc_${{ github.event.release.name }}_checksums.txt
files: | sha256sum croc_${{ github.event.release.name }}_NetBSD-ARM64.tar.gz >> croc_${{ github.event.release.name }}_checksums.txt
croc_${{ github.event.release.name }}_checksums.txt sha256sum croc_${{ github.event.release.name }}_OpenBSD-64bit.tar.gz >> croc_${{ github.event.release.name }}_checksums.txt
croc_${{ github.event.release.name }}_src.tar.gz sha256sum croc_${{ github.event.release.name }}_OpenBSD-ARM64.tar.gz >> croc_${{ github.event.release.name }}_checksums.txt
croc_${{ github.event.release.name }}_Windows-64bit.zip
croc_${{ github.event.release.name }}_Windows-32bit.zip - name: Release
croc_${{ github.event.release.name }}_Windows-ARM.zip uses: softprops/action-gh-release@v2
croc_${{ github.event.release.name }}_Windows-ARM64.zip with:
croc_${{ github.event.release.name }}_Windows7-64bit.zip files: |
croc_${{ github.event.release.name }}_Windows7-32bit.zip croc_${{ github.event.release.name }}_checksums.txt
croc_${{ github.event.release.name }}_Linux-64bit.tar.gz croc_${{ github.event.release.name }}_src.tar.gz
croc_${{ github.event.release.name }}_Linux-32bit.tar.gz croc_${{ github.event.release.name }}_Windows-64bit.zip
croc_${{ github.event.release.name }}_Linux-ARM.tar.gz croc_${{ github.event.release.name }}_Windows-32bit.zip
croc_${{ github.event.release.name }}_Linux-ARMv5.tar.gz croc_${{ github.event.release.name }}_Windows-ARM.zip
croc_${{ github.event.release.name }}_Linux-ARM64.tar.gz croc_${{ github.event.release.name }}_Windows-ARM64.zip
croc_${{ github.event.release.name }}_macOS-64bit.tar.gz croc_${{ github.event.release.name }}_Windows7-64bit.zip
croc_${{ github.event.release.name }}_macOS-ARM64.tar.gz croc_${{ github.event.release.name }}_Windows7-32bit.zip
croc_${{ github.event.release.name }}_DragonFlyBSD-64bit.tar.gz croc_${{ github.event.release.name }}_Linux-64bit.tar.gz
croc_${{ github.event.release.name }}_FreeBSD-64bit.tar.gz croc_${{ github.event.release.name }}_Linux-32bit.tar.gz
croc_${{ github.event.release.name }}_FreeBSD-ARM64.tar.gz croc_${{ github.event.release.name }}_Linux-ARM.tar.gz
croc_${{ github.event.release.name }}_NetBSD-32bit.tar.gz croc_${{ github.event.release.name }}_Linux-ARMv5.tar.gz
croc_${{ github.event.release.name }}_NetBSD-64bit.tar.gz croc_${{ github.event.release.name }}_Linux-ARM64.tar.gz
croc_${{ github.event.release.name }}_NetBSD-ARM64.tar.gz croc_${{ github.event.release.name }}_macOS-64bit.tar.gz
croc_${{ github.event.release.name }}_OpenBSD-64bit.tar.gz croc_${{ github.event.release.name }}_macOS-ARM64.tar.gz
croc_${{ github.event.release.name }}_OpenBSD-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

25
.github/workflows/stale.yml vendored
View file

@ -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 name: Mark stale issues and pull requests
on: on:
schedule: schedule:
- cron: '19 12 * * *' - cron: '0 0 * * *'
jobs: jobs:
stale: stale:
runs-on: ubuntu-24.04
runs-on: ubuntu-latest
permissions: permissions:
issues: write issues: write
pull-requests: write pull-requests: write
steps: steps:
- uses: actions/stale@v9 - name: Stale
with: uses: actions/stale@v9
repo-token: ${{ secrets.GITHUB_TOKEN }} with:
stale-issue-message: 'Stale issue message' repo-token: ${{ secrets.GITHUB_TOKEN }}
stale-pr-message: 'Stale pull request message' stale-issue-message: 'This issue has been marked stale because it has been open for 60 days with no activity.'
stale-issue-label: 'no-issue-activity' stale-pr-message: 'This pull request has been marked stale because it has been open for 60 days with no activity.'
stale-pr-label: 'no-pr-activity' stale-issue-label: 'no-issue-activity'
stale-pr-label: 'no-pr-activity'

8
.github/workflows/winget.yml vendored
View file

@ -1,13 +1,17 @@
name: Publish to Winget name: Publish to Winget
on: on:
release: release:
types: [released] types: [released]
workflow_dispatch:
jobs: jobs:
publish: publish:
runs-on: ubuntu-latest runs-on: ubuntu-24.04
steps: steps:
- uses: vedantmgoyal2009/winget-releaser@v2 - name: Publish to Winget
uses: vedantmgoyal9/winget-releaser@v2
with: with:
identifier: schollz.croc identifier: schollz.croc
installers-regex: '_Windows-\w+\.zip$' installers-regex: '_Windows-\w+\.zip$'

36
.gitignore vendored
View file

@ -1,13 +1,25 @@
# Binaries # If you prefer the allow list template instead of the deny list, see community template:
/croc # https://github.com/github/gitignore/blob/main/community/Golang/Go.AllowList.gitignore
/croc.exe #
zsh_autocomplete # Binaries for programs and plugins
bash_autocomplete *.exe
dist *.exe~
bin *.dll
croc-stdin* *.so
*.dylib
.idea/ # Test binary, built with `go test -c`
.vscode/ *.test
src/utils/bigfile.test
test1/ # 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

16
.goreleaser.yml
View file

@ -1,4 +1,5 @@
project_name: croc project_name: croc
build: build:
main: main.go main: main.go
binary: croc binary: croc
@ -25,9 +26,9 @@ build:
goarch: arm goarch: arm
goarm: goarm:
- 7 - 7
nfpms: nfpms:
- - formats:
formats:
- deb - deb
vendor: "schollz.com" vendor: "schollz.com"
homepage: "https://schollz.com/software/croc/" homepage: "https://schollz.com/software/croc/"
@ -47,9 +48,9 @@ nfpms:
netbsd: NetBSD netbsd: NetBSD
freebsd: FreeBSD freebsd: FreeBSD
dragonfly: DragonFlyBSD dragonfly: DragonFlyBSD
archives: archives:
- - format: tar.gz
format: tar.gz
format_overrides: format_overrides:
- goos: windows - goos: windows
format: zip format: zip
@ -73,8 +74,7 @@ archives:
- bash_autocomplete - bash_autocomplete
brews: brews:
- - tap:
tap:
owner: schollz owner: schollz
name: homebrew-tap name: homebrew-tap
folder: Formula folder: Formula
@ -82,7 +82,6 @@ brews:
homepage: "https://schollz.com/software/croc/" homepage: "https://schollz.com/software/croc/"
install: | install: |
bin.install "croc" bin.install "croc"
test: | test: |
system "#{bin}/croc --version" system "#{bin}/croc --version"
@ -93,8 +92,7 @@ scoop:
homepage: "https://schollz.com/software/croc/" homepage: "https://schollz.com/software/croc/"
description: "croc is a tool that allows any two computers to simply and securely transfer files and folders." description: "croc is a tool that allows any two computers to simply and securely transfer files and folders."
license: MIT license: MIT
announce: announce:
twitter: twitter:
# Wether its enabled or not.
# Defaults to false.
enabled: false enabled: false

4
.travis.yml
View file

@ -19,5 +19,5 @@ script:
branches: branches:
except: except:
- dev - dev
- win - win

10
Dockerfile
View file

@ -1,16 +1,24 @@
FROM golang:1.22-alpine as builder FROM golang:1.23-alpine as builder
RUN apk add --no-cache git gcc musl-dev RUN apk add --no-cache git gcc musl-dev
WORKDIR /go/croc WORKDIR /go/croc
COPY . . COPY . .
RUN go build -v -ldflags="-s -w" RUN go build -v -ldflags="-s -w"
FROM alpine:latest FROM alpine:latest
EXPOSE 9009 EXPOSE 9009
EXPOSE 9010 EXPOSE 9010
EXPOSE 9011 EXPOSE 9011
EXPOSE 9012 EXPOSE 9012
EXPOSE 9013 EXPOSE 9013
COPY --from=builder /go/croc/croc /go/croc/croc-entrypoint.sh / COPY --from=builder /go/croc/croc /go/croc/croc-entrypoint.sh /
USER nobody USER nobody
ENTRYPOINT ["/croc-entrypoint.sh"] ENTRYPOINT ["/croc-entrypoint.sh"]
CMD ["relay"] CMD ["relay"]

191
README.md
View file

@ -1,53 +1,58 @@
<p align="center"> <p align="center">
<img <img src="https://user-images.githubusercontent.com/6550035/46709024-9b23ad00-cbf6-11e8-9fb2-ca8b20b7dbec.jpg" width="408px" border="0" alt="croc">
src="https://user-images.githubusercontent.com/6550035/46709024-9b23ad00-cbf6-11e8-9fb2-ca8b20b7dbec.jpg" <br>
width="408px" border="0" alt="croc"> <a href="https://github.com/schollz/croc/releases/latest">
<br> <img src="https://img.shields.io/github/v/release/schollz/croc" alt="Version">
<a href="https://github.com/schollz/croc/releases/latest"><img src="https://img.shields.io/badge/version-v10.2.1-brightgreen.svg?style=flat-square" alt="Version"></a> </a>
<a href="https://github.com/schollz/croc/actions/workflows/ci.yml"><img <a href="https://github.com/schollz/croc/actions/workflows/ci.yml">
src="https://github.com/schollz/croc/actions/workflows/ci.yml/badge.svg" alt="Build <img src="https://github.com/schollz/croc/actions/workflows/ci.yml/badge.svg" alt="Build Status">
Status"></a> </a>
<p align="center">This project is supported by <a href="https://github.com/sponsors/schollz">Github sponsors</a>.</p> </p>
<p align="center">
This project is supported by <a href="https://github.com/sponsors/schollz">GitHub sponsors</a>.
</p>
## 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: `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) - Allows **any two computers** to transfer data (using a relay)
- provides **end-to-end encryption** (using PAKE) - Provides **end-to-end encryption** (using PAKE)
- enables easy **cross-platform** transfers (Windows, Linux, Mac) - Enables easy **cross-platform** transfers (Windows, Linux, Mac)
- allows **multiple file** transfers - Allows **multiple file** transfers
- allows **resuming transfers** that are interrupted - Allows **resuming transfers** that are interrupted
- local server or port-forwarding **not needed** - No need for local server or port-forwarding
- **ipv6-first** with ipv4 fallback - **IPv6-first** with IPv4 fallback
- can **use proxy**, like tor - 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) ![Example](src/install/customization.gif)
## Install ## 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 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
``` ```
On macOS you can also install the latest release with [MacPorts](https://macports.org/): Using [MacPorts](https://www.macports.org/):
```bash
```
sudo port selfupdate sudo port selfupdate
sudo port install croc 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/): ### On Windows
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 ```bash
scoop install croc scoop install croc
@ -61,70 +66,88 @@ choco install croc
winget install schollz.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 ```bash
nix-env -i croc nix-env -i croc
``` ```
### On Alpine Linux
On Alpine Linux you have to install dependencies first: First, install dependencies:
```bash ```bash
apk add bash coreutils apk add bash coreutils
wget -qO- https://getcroc.schollz.com | bash 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 ```bash
pacman -S croc pacman -S croc
``` ```
On Fedora you can install with `dnf`: ### On Fedora
Install with `dnf`:
```bash ```bash
dnf install croc dnf install croc
``` ```
On Gentoo you can install with `portage`: ### On Gentoo
Install with `portage`:
```bash ```bash
emerge net-misc/croc emerge net-misc/croc
``` ```
On Termux you can install with `pkg`: ### On Termux
Install with `pkg`:
```bash ```bash
pkg install croc pkg install croc
``` ```
On FreeBSD you can install with `pkg`: ### On FreeBSD
Install with `pkg`:
```bash ```bash
pkg install croc 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 ```bash
pixi global install croc 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 ```bash
conda install --channel conda-forge croc 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.22+):
```bash ```bash
go install github.com/schollz/croc/v10@latest 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 ## Usage
@ -136,62 +159,55 @@ Sending 'file-or-folder' (X MB)
Code is: code-phrase 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 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. 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 ```bash
CROC_SECRET=*** croc CROC_SECRET=*** croc
``` ```
This will show only `croc` in the process list of a multi-user system and not leak the secret. For single-user systems, the default behavior can be permanently enabled by running:
For a single-user system the default behavior can be permanently enabled by running
```bash ```bash
croc --classic croc --classic
``` ```
and confirming. #### Custom Code Phrase
Run this command again to disable classic mode.
### 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 ```bash
croc send --code [code-phrase] [file(s)-or-folder] 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 ```bash
croc --yes --overwrite <code> croc --yes --overwrite <code>
``` ```
### 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 ```bash
croc send --exclude "node_modules,.venv" [folder] 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`: You can pipe to `croc`:
@ -199,93 +215,80 @@ You can pipe to `croc`:
cat [filename] | croc send 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 ```bash
croc --yes [code-phrase] > out 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
To send URLs or short text, use:
### Send text
Sometimes you want to send URLs or short text. In addition to piping, you can easily send text with `croc`:
```bash ```bash
croc send --text "hello world" 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
You can send files via a proxy by adding `--socks5`:
### 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:
```bash ```bash
croc --socks5 "127.0.0.1:9050" send SOMEFILE 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 ```bash
croc --curve p521 <codephrase> croc --curve p521 <codephrase>
``` ```
Available curves are P-256, P-348, P-521 and SIEC. P-256 is the default curve. #### Change Hash Algorithm
### Change hash algorithm For faster hashing, use the `imohash` 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.
```bash ```bash
croc send --hash imohash SOMEFILE 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 ```bash
croc relay 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 ```bash
croc --relay "myrelay.example.com:9009" send [filename] 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 with Docker
#### Self-host relay (docker)
If it's easier you can also run a relay with Docker:
You can also run a relay with Docker:
```bash ```bash
docker run -d -p 9009-9013:9009-9013 -e CROC_PASS='YOURPASSWORD' schollz/croc 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 ```bash
croc --pass YOURPASSWORD --relay "myreal.example.com:9009" send [filename] 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 ## 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!

2
croc-entrypoint.sh
View file

@ -1,6 +1,8 @@
#!/bin/sh #!/bin/sh
set -e set -e
if [ -n "$CROC_PASS" ]; then if [ -n "$CROC_PASS" ]; then
set -- --pass "$CROC_PASS" "$@" set -- --pass "$CROC_PASS" "$@"
fi fi
exec /croc "$@" exec /croc "$@"

6
go.mod
View file

@ -1,8 +1,8 @@
module github.com/schollz/croc/v10 module github.com/schollz/croc/v10
go 1.22 go 1.23
toolchain go1.23.1 toolchain go1.23.5
require ( require (
github.com/cespare/xxhash/v2 v2.3.0 github.com/cespare/xxhash/v2 v2.3.0
@ -18,7 +18,7 @@ require (
github.com/schollz/peerdiscovery v1.7.6 github.com/schollz/peerdiscovery v1.7.6
github.com/schollz/progressbar/v3 v3.18.0 github.com/schollz/progressbar/v3 v3.18.0
github.com/skip2/go-qrcode v0.0.0-20200617195104-da1b6568686e 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/crypto v0.32.0
golang.org/x/net v0.34.0 golang.org/x/net v0.34.0
golang.org/x/sys v0.29.0 golang.org/x/sys v0.29.0

4
go.sum
View file

@ -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/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/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.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.10.0 h1:Xv5erBjTwe/5IxqUQTdXv5kgmIvbHo3QQyRwhJsOfJA=
github.com/stretchr/testify v1.9.0/go.mod h1:r2ic/lqez/lEtzL7wO/rwa5dbSLXVDPFyf8C91i36aY= 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-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 h1:sDWDZkwYqX0jvLWstKzFwh+pYhQNaVg65BgSkCP/f7U=
github.com/tscholl2/siec v0.0.0-20240310163802-c2c6f6198406/go.mod h1:KL9+ubr1JZdaKjgAaHr+tCytEncXBa1pR6FjbTsOJnw= github.com/tscholl2/siec v0.0.0-20240310163802-c2c6f6198406/go.mod h1:KL9+ubr1JZdaKjgAaHr+tCytEncXBa1pR6FjbTsOJnw=