Home

Awesome

logo

The command-line client for Tefter.

Installation

Via brew:

brew tap tefter/homebrew-cli
brew install tefter

Alternatively download a compatible release for your system from releases.

Extract and run tefter_cli.

The first time you run it, it'll try to open a browser window to authenticate your Tefter account. This method of of authentication works if you've already signed up via the browser and are logged in. A fallback auth mechanism is to create a ~/.tefter file with your API token.

{
  "token": "your_token_here"
}

You will find your token here.

Features

Search

search

Use enter to open a browser window with a result.

Aliases

aliases

Commands

Create an alias.

:c <alias> <url>

Delete an alias.

:d

Bookmarks

bookmarks

Filtering

filtering

Use / to start filtering.

Commands

commands

Add a bookmark.

:c <url>

Delete a bookmark.

:d

Modals

Use the :s command to display more details about the bookmark under the cursor.

modals

Usage

usage

Shortcuts

KeyAction
<kbd>Ctrl</kbd>+<kbd>s</kbd>Jump to Search tab
<kbd>Ctrl</kbd>+<kbd>a</kbd>Jump to Aliases tab
<kbd>Ctrl</kbd>+<kbd>b</kbd>Jump to Bookmarks tab
<kbd>Ctrl</kbd>+<kbd>h</kbd>Jump to Help tab
<kbd>Tab</kbd>Jump to the next tab
<kbd>Home</kbd>Jump to the first tab
<kbd></kbd>Move up
<kbd>Ctrl</kbd>+<kbd>k</kbd>Move up
<kbd></kbd>Move down
<kbd>Ctrl</kbd>+<kbd>j</kbd>Move down
<kbd>Ctrl</kbd>+<kbd>d</kbd>Scroll down
<kbd>Ctrl</kbd>+<kbd>u</kbd>Scroll up
<kbd>Enter</kbd>Open browser window with item under cursor
<kbd>Esc</kbd>Cancel command / Quit modal
<kbd>F5</kbd>Force refresh resources
<kbd>Ctrl</kbd>+<kbd>q</kbd>Quit
<kbd>/</kbd>Enter filtering mode
<kbd>:</kbd>Enter command mode

Running Locally

First, ensure you have the following versions of Elixir and OTP installed on your machine:

erlang 21.3.2
elixir 1.9

Then, run:

git clone git@github.com:tefter/cli.git
mix deps.get
mix run --no-halt

Releasing

You can build portable releases per platform, which include the Erlang VM and don't require installing Erlang / Elixir on the target system.

Linux

Run:

./bin/release_linux

MacOS

Run:

./bin/release_macos

License

Copyright (c) 2020 Tefter, GPLv3 License. See LICENSE.txt for further details.