Skip to content

tefter/cli

master
Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
bin
 
 
 
 
lib
 
 
log
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

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

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