Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: update deps, local-only skate #102

Merged
merged 13 commits into from
Aug 23, 2024
Merged
9 changes: 0 additions & 9 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
Expand Up @@ -18,12 +18,3 @@ updates:
commit-message:
prefix: "chore"
include: "scope"
- package-ecosystem: "docker"
directory: "/"
schedule:
interval: "daily"
labels:
- "dependencies"
commit-message:
prefix: "feat"
include: "scope"
4 changes: 1 addition & 3 deletions .github/workflows/goreleaser.yml
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,8 @@ jobs:
goreleaser:
uses: charmbracelet/meta/.github/workflows/goreleaser.yml@main
secrets:
docker_username: ${{ secrets.DOCKERHUB_USERNAME }}
docker_token: ${{ secrets.DOCKERHUB_TOKEN }}
gh_pat: ${{ secrets.PERSONAL_ACCESS_TOKEN }}
goreleaser_key: ${{ secrets.GORELEASER_KEY }}
fury_token: ${{ secrets.FURY_TOKEN }}
nfpm_gpg_key: ${{ secrets.NFPM_GPG_KEY }}
nfpm_passphrase: ${{ secrets.NFPM_PASSPHRASE }}
nfpm_passphrase: ${{ secrets.NFPM_PASSPHRASE }}
2 changes: 0 additions & 2 deletions .golangci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -19,11 +19,9 @@ linters:
- exportloopref
- goconst
- godot
- godox
- goimports
- goprintffuncname
- gosec
- ifshort
- misspell
- prealloc
- revive
Expand Down
6 changes: 5 additions & 1 deletion .goreleaser.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@
# yaml-language-server: $schema=https://goreleaser.com/static/schema-pro.json

version: 2

includes:
- from_url:
url: charmbracelet/meta/main/goreleaser-semi.yaml
url: charmbracelet/meta/main/goreleaser-simple.yaml

variables:
binary_name: skate
Expand Down
5 changes: 0 additions & 5 deletions Dockerfile

This file was deleted.

2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
MIT License

Copyright (c) 2021-2023 Charmbracelet, Inc
Copyright (c) 2021-2024 Charmbracelet, Inc

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
70 changes: 8 additions & 62 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,7 @@
A personal key-value store. 🛼

Skate is simple and powerful. Use it to save and retrieve anything you’d
like—even binary data. It’s fully encrypted, backed up to the cloud (that you
can self-host if you want) and can be synced with all your machines.
like—even binary data.

```bash
# Store something (and sync it to the network)
Expand All @@ -22,9 +21,6 @@ skate get kitty
# What’s in the store?
skate list

# Pull down the latest data
skate sync

# Spaces are fine
skate set "kitty litter" "smells great"

Expand Down Expand Up @@ -79,8 +75,8 @@ sudo yum install skate

Or download it:

* [Packages][releases] are available in Debian and RPM formats
* [Binaries][releases] are available for Linux, macOS, and Windows
- [Packages][releases] are available in Debian and RPM formats
- [Binaries][releases] are available for Linux, macOS, and Windows

Or just install it with `go`:

Expand All @@ -93,6 +89,7 @@ go install github.com/charmbracelet/skate@latest
## Other Features

### List Filters

```bash
# list keys only
skate list -k
Expand Down Expand Up @@ -125,30 +122,8 @@ skate list @work-stuff

# Wait, what was that db named?
skate list-dbs

# Oh no, the boss is coming!
skate reset @work-stuff
```

### Linking

One of the most powerful features of Skate is its ability to link two machines
together so they have access to the same data. To link two machines together
just run:

```bash
skate link
```

And follow the instructions. Keep in mind that you'll need access to both
machines.

### Syncing

When you run `skate set`, data is encrypted and synced to the network. When
you `get`, however, data is loaded from the local cache. To fetch any new data
from the server just run `skate sync`.

## Examples

Here are some of our favorite ways to use `skate`.
Expand Down Expand Up @@ -181,48 +156,19 @@ skate list @bookmarks.db

What do you use `skate` for? [Let us know](mailto:[email protected]).

## Self-Hosting

Skate is backed by the Charm Cloud. By default, it will use the Charm hosted
cloud, but it’s incredibly easy to self-host, even if that’s just on your
local network. For details, see the [Charm docs][selfhost].

[selfhost]: https://github.com/charmbracelet/charm#self-hosting

If you've finished setting up your very own Charm Cloud, great.
To make `skate` connect to your self-hosted instance, you'll need to change the
`CHARM_HOST` environment variable to point to the domain/IP of where you hosted
your Charm Cloud. If you would like to change anything else about the Skate
client, you can do so by changing the Charm client [environment
variables][client-vars].

[client-vars]: https://github.com/charmbracelet/charm#client-settings

## Hey, Developers

Skate is built on [Charm KV][charm-kv]. If you’d like to build a tool that
includes a user key value store, check it out. Skate has the same functionality
as `charm kv`, but it uses a separate database.

If you have questions about the underlying file system Skate uses, head on over
to our [Charm FS FAQ][faq].

[charm-kv]: https://github.com/charmbracelet/charm#charm-kv
[faq]: https://github.com/charmbracelet/charm#faq

## Feedback

We’d love to hear your thoughts on this project. Feel free to drop us a note!

* [Twitter](https://twitter.com/charmcli)
* [The Fediverse](https://mastodon.social/@charmcli)
* [Discord](https://charm.sh/chat)
- [Twitter](https://twitter.com/charmcli)
- [The Fediverse](https://mastodon.social/@charmcli)
- [Discord](https://charm.sh/chat)

## License

[MIT](https://github.com/charmbracelet/skate/raw/main/LICENSE)

***
---

Part of [Charm](https://charm.sh).

Expand Down
72 changes: 12 additions & 60 deletions go.mod
Original file line number Diff line number Diff line change
@@ -1,94 +1,46 @@
module github.com/charmbracelet/skate

go 1.17
go 1.21

require (
github.com/agnivade/levenshtein v1.1.1
github.com/charmbracelet/charm v0.12.6
github.com/charmbracelet/lipgloss v0.10.0
github.com/dgraph-io/badger/v3 v3.2103.5
github.com/charmbracelet/lipgloss v0.13.0
github.com/dgraph-io/badger/v4 v4.2.0
github.com/muesli/go-app-paths v0.2.2
github.com/muesli/mango-cobra v1.2.0
github.com/muesli/roff v0.1.0
github.com/spf13/cobra v1.8.0
github.com/spf13/cobra v1.8.1
golang.org/x/term v0.23.0
)

require (
github.com/anmitsu/go-shlex v0.0.0-20200514113438-38f4b401e2be // indirect
github.com/auth0/go-jwt-middleware/v2 v2.0.1 // indirect
github.com/aymanbagabas/go-osc52/v2 v2.0.1 // indirect
github.com/beorn7/perks v1.0.1 // indirect
github.com/caarlos0/env/v6 v6.10.1 // indirect
github.com/caarlos0/sshmarshal v0.1.0 // indirect
github.com/calmh/randomart v1.1.0 // indirect
github.com/cespare/xxhash v1.1.0 // indirect
github.com/cespare/xxhash/v2 v2.2.0 // indirect
github.com/charmbracelet/bubbles v0.15.0 // indirect
github.com/charmbracelet/bubbletea v0.23.2 // indirect
github.com/charmbracelet/keygen v0.4.2 // indirect
github.com/charmbracelet/log v0.2.2 // indirect
github.com/charmbracelet/ssh v0.0.0-20221117183211-483d43d97103 // indirect
github.com/charmbracelet/wish v1.1.1 // indirect
github.com/containerd/console v1.0.3 // indirect
github.com/charmbracelet/x/ansi v0.1.4 // indirect
github.com/dgraph-io/ristretto v0.1.1 // indirect
github.com/dustin/go-humanize v1.0.0 // indirect
github.com/go-logfmt/logfmt v0.6.0 // indirect
github.com/gogo/protobuf v1.3.2 // indirect
github.com/golang-jwt/jwt/v4 v4.5.0 // indirect
github.com/golang/glog v0.0.0-20160126235308-23def4e6c14b // indirect
github.com/golang/glog v1.0.0 // indirect
github.com/golang/groupcache v0.0.0-20200121045136-8c9f03a8e57e // indirect
github.com/golang/protobuf v1.5.3 // indirect
github.com/golang/snappy v0.0.3 // indirect
github.com/google/flatbuffers v1.12.1 // indirect
github.com/google/uuid v1.3.0 // indirect
github.com/google/go-cmp v0.5.9 // indirect
github.com/inconshreveable/mousetrap v1.1.0 // indirect
github.com/jacobsa/crypto v0.0.0-20190317225127-9f44e2d11115 // indirect
github.com/kballard/go-shellquote v0.0.0-20180428030007-95032a82bc51 // indirect
github.com/klauspost/compress v1.12.3 // indirect
github.com/lucasb-eyer/go-colorful v1.2.0 // indirect
github.com/mattn/go-isatty v0.0.19 // indirect
github.com/mattn/go-localereader v0.0.1 // indirect
github.com/mattn/go-isatty v0.0.20 // indirect
github.com/mattn/go-runewidth v0.0.15 // indirect
github.com/matttproud/golang_protobuf_extensions v1.0.4 // indirect
github.com/meowgorithm/babylogger v1.2.0 // indirect
github.com/mitchellh/go-homedir v1.1.0 // indirect
github.com/muesli/ansi v0.0.0-20211018074035-2e021307bc4b // indirect
github.com/muesli/cancelreader v0.2.2 // indirect
github.com/muesli/go-app-paths v0.2.2 // indirect
github.com/muesli/mango v0.1.0 // indirect
github.com/muesli/mango-pflag v0.1.0 // indirect
github.com/muesli/reflow v0.3.0 // indirect
github.com/muesli/sasquatch v0.0.0-20200811221207-66979d92330a // indirect
github.com/muesli/termenv v0.15.2 // indirect
github.com/muesli/toktok v0.1.0 // indirect
github.com/pkg/errors v0.9.1 // indirect
github.com/prometheus/client_golang v1.15.1 // indirect
github.com/prometheus/client_model v0.3.0 // indirect
github.com/prometheus/common v0.42.0 // indirect
github.com/prometheus/procfs v0.9.0 // indirect
github.com/remyoudompheng/bigfft v0.0.0-20200410134404-eec4a21b6bb0 // indirect
github.com/rivo/uniseg v0.4.7 // indirect
github.com/spf13/pflag v1.0.5 // indirect
github.com/xrash/smetrics v0.0.0-20201216005158-039620a65673 // indirect
github.com/stretchr/testify v1.8.3 // indirect
go.opencensus.io v0.22.5 // indirect
goji.io v2.0.2+incompatible // indirect
golang.org/x/crypto v0.10.0 // indirect
golang.org/x/mod v0.8.0 // indirect
golang.org/x/net v0.10.0 // indirect
golang.org/x/sync v0.1.0 // indirect
golang.org/x/sys v0.12.0 // indirect
golang.org/x/term v0.9.0 // indirect
golang.org/x/text v0.10.0 // indirect
golang.org/x/tools v0.6.0 // indirect
golang.org/x/sys v0.23.0 // indirect
google.golang.org/protobuf v1.30.0 // indirect
gopkg.in/square/go-jose.v2 v2.6.0 // indirect
lukechampine.com/uint128 v1.1.1 // indirect
modernc.org/cc/v3 v3.36.0 // indirect
modernc.org/ccgo/v3 v3.16.8 // indirect
modernc.org/libc v1.16.19 // indirect
modernc.org/mathutil v1.4.1 // indirect
modernc.org/memory v1.1.1 // indirect
modernc.org/opt v0.1.1 // indirect
modernc.org/sqlite v1.18.1 // indirect
modernc.org/strutil v1.1.1 // indirect
modernc.org/token v1.0.0 // indirect
)
Loading
Loading