Skip to content
Find file
Fetching contributors…
Cannot retrieve contributors at this time
71 lines (40 sloc) 1.81 KB


This package exposes a directory and its children to create, read, update, and delete operations over http.

Command-line usage

 crud-file-server [options]

This starts a file server using the specified command-line options.

-f file system path to expose over http
-p port to listen on (example, 80)
-q suppress this message
-r read only
-v virtual path to host the file server on  


crud-file-server -f c:/ -p 8080 -v filez -q 

Server-Side Usage

var port = 80;
var path = '';
require('http').createServer(function (req, res) {
    require('crud-file-server').handleRequest(port, path, req, res);

Supported operations

GET returns a file's contents with the correct mime type, or else the contents of a directory as html.

GET http://localhost?dir=json returns directories as json instead of html.

PUT can be used to write a file.

DELETE can be used to delete a file or folder.

POST supports two operations, rename and create directory.

POST http://localhost/newDir?create=directory would create a directory named newDir.

POST http://localhost/abc.html?rename=def.html would rename abc.html to def.html.

Run the Example

For further clarification, try running the example.

npm install crud-file-server

Navigate to the example directory (which should now be under node_modules/crud-file-server/example).

cd node_modules/crud-file-server/example

Run crud-file-server to host the current directory.

crud-file-server -p 3300

Now use your browser to navigate to http://localhost:3300/example.html.
You will see a simple client that lets you interact with your file system from the web browser.

Jump to Line
Something went wrong with that request. Please try again.