mirror of
https://github.com/valeriangalliat/firefox-sync-cli
synced 2024-06-29 02:40:17 +02:00
Compare commits
No commits in common. "master" and "v1.0.0" have entirely different histories.
24
README.md
24
README.md
|
@ -1,4 +1,4 @@
|
||||||
# Firefox Sync CLI [![npm version](http://img.shields.io/npm/v/firefox-sync-cli.svg?style=flat-square)](https://www.npmjs.org/package/firefox-sync-cli)
|
# Firefox Sync CLI
|
||||||
|
|
||||||
> Manage Firefox Sync from the CLI! ✨
|
> Manage Firefox Sync from the CLI! ✨
|
||||||
|
|
||||||
|
@ -16,14 +16,6 @@ It features two ways to authenticate, one using a Firefox Accounts email
|
||||||
and password to open a session, and one using OAuth. See more about them
|
and password to open a session, and one using OAuth. See more about them
|
||||||
[below](#authentication).
|
[below](#authentication).
|
||||||
|
|
||||||
## Installation
|
|
||||||
|
|
||||||
```sh
|
|
||||||
npm install -g firefox-sync-cli
|
|
||||||
```
|
|
||||||
|
|
||||||
The command will be available as `ffs`. 😏
|
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
|
||||||
```
|
```
|
||||||
|
@ -55,20 +47,6 @@ Commands:
|
||||||
help [command] Display help for command.
|
help [command] Display help for command.
|
||||||
```
|
```
|
||||||
|
|
||||||
A typical flow will look like this:
|
|
||||||
|
|
||||||
```sh
|
|
||||||
ffs -c ~/.ffs-creds.json oauth
|
|
||||||
ffs -c ~/.ffs-creds.json collections
|
|
||||||
ffs -c ~/.ffs-creds.json get bookmarks --full
|
|
||||||
```
|
|
||||||
|
|
||||||
During authentication, this will create `~/.ffs-creds.json` to store the
|
|
||||||
credentials necessary to access Firefox Sync.
|
|
||||||
|
|
||||||
Further commands read credentials from this file to use that session to
|
|
||||||
query the API.
|
|
||||||
|
|
||||||
## Authentication
|
## Authentication
|
||||||
|
|
||||||
### Email and password
|
### Email and password
|
||||||
|
|
4
ffs
4
ffs
|
@ -3,7 +3,3 @@
|
||||||
const cli = require('./cli')
|
const cli = require('./cli')
|
||||||
|
|
||||||
cli(process.argv)
|
cli(process.argv)
|
||||||
.catch(err => {
|
|
||||||
console.error(err.stack || err)
|
|
||||||
process.exit(1)
|
|
||||||
})
|
|
||||||
|
|
|
@ -1,6 +1,6 @@
|
||||||
{
|
{
|
||||||
"name": "firefox-sync-cli",
|
"name": "firefox-sync-cli",
|
||||||
"version": "1.0.2",
|
"version": "1.0.0",
|
||||||
"description": "Manage Firefox Sync from the CLI! ✨",
|
"description": "Manage Firefox Sync from the CLI! ✨",
|
||||||
"license": "Unlicense",
|
"license": "Unlicense",
|
||||||
"author": "Val (https://val.codejam.info)",
|
"author": "Val (https://val.codejam.info)",
|
||||||
|
@ -20,7 +20,7 @@
|
||||||
},
|
},
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"commander": "^8.2.0",
|
"commander": "^8.2.0",
|
||||||
"firefox-sync": "^1.1.0",
|
"firefox-sync": "^1.0.0",
|
||||||
"ini": "^2.0.0",
|
"ini": "^2.0.0",
|
||||||
"prompts": "^2.4.2",
|
"prompts": "^2.4.2",
|
||||||
"sqlite": "^4.0.23",
|
"sqlite": "^4.0.23",
|
||||||
|
|
Loading…
Reference in a new issue