From b746b10658e8b75f41867703ed6ffc47f9a13f3c Mon Sep 17 00:00:00 2001 From: Mathias Buus Date: Wed, 18 Dec 2019 10:32:09 +0100 Subject: [PATCH] cli docs --- README.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/README.md b/README.md index 012a54b..8749333 100644 --- a/README.md +++ b/README.md @@ -90,6 +90,8 @@ Might require `sudo` access. Unconfigures FUSE on your machine. Basically undos any change the above method does. +See the CLI section below on how to run these commands from the command line if you prefer doing that. + ### FUSE API Most of the [FUSE api](http://fuse.sourceforge.net/doxygen/structfuse__operations.html) is supported. In general the callback for each op should be called with `cb(returnCode, [value])` where the return code is a number (`0` for OK and `< 0` for errors). See below for a list of POSIX error codes. @@ -307,6 +309,17 @@ Called when a new directory is being created Called when a directory is being removed +## CLI + +There is a CLI tool available to help you configure the FUSE kernel extension setup +if you don't want to use the JavaScript API for that + +``` +npm install -g fuse-native +fuse-native is-configured # checks if the kernel extension is already configured +fuse-native configure # configures the kernel extension +``` + ## License MIT for these bindings.