# napier-client > simple web proxy service client Latest version **2.708.4** (published 2026-01-16) · Apache-2.0-or-later license · 0 weekly downloads ## Install ```sh npm install napier-client pnpm add napier-client yarn add napier-client bun add napier-client ``` Provides the commands `napier-cli`, `napier-password`. ## Health **Score 50/100 (C)** — status: stable. Positive: no vulnerabilities; has provenance. Warnings: low downloads; no types; no esm support. ## Facts | | | |---|---| | Version | 2.708.4 | | Published | 2026-01-16 | | First published | 2023-06-14 | | Weekly downloads | 0 | | License | Apache-2.0-or-later | | TypeScript types | none | | Module format | CommonJS | | Dependencies | 41 | | Unpacked size | 1.4 MB | | Known vulnerabilities | 0 (+3 in 3 direct dependencies) | | Install scripts | no | | Provenance | attested (GitHub Actions) | | GitHub stars | 0 | | Author | Masami Ogoshi | | Maintainers | waspcojp | ## Links - npm: https://www.npmjs.com/package/napier-client - Repository: https://github.com/waspcojp/napier-client - Issues: https://github.com/waspcojp/napier-client/issues - npm.io page: https://npm.io/package/napier-client ## Dependencies (41) - [ws](https://npm.io/package/ws.md) ^8.8.0 - [ejs](https://npm.io/package/ejs.md) ^3.1.9 - [mime](https://npm.io/package/mime.md) ^3.0.0 - [axios](https://npm.io/package/axios.md) ^1.3.5 - [bytes](https://npm.io/package/bytes.md) ^3.1.2 - [assert](https://npm.io/package/assert.md) ^2.0.0 - [bcrypt](https://npm.io/package/bcrypt.md) ^5.1.0 - [cookie](https://npm.io/package/cookie.md) ^0.5.0 - [deasync](https://npm.io/package/deasync.md) ^0.1.28 - [prismjs](https://npm.io/package/prismjs.md) ^1.25.0 - [sqlite3](https://npm.io/package/sqlite3.md) ^5.0.10 - [node-gyp](https://npm.io/package/node-gyp.md) ^9.3.1 - [node-rsa](https://npm.io/package/node-rsa.md) ^1.1.1 - [commander](https://npm.io/package/commander.md) ^9.4.0 - [minimatch](https://npm.io/package/minimatch.md) ^5.1.2 - [node-uuid](https://npm.io/package/node-uuid.md) ^1.4.8 - [sprightly](https://npm.io/package/sprightly.md) ^2.0.1 - [markdown-it](https://npm.io/package/markdown-it.md) ^12.3.2 - [range-parser](https://npm.io/package/range-parser.md) ^1.2.1 - [tough-cookie](https://npm.io/package/tough-cookie.md) ^4.1.2 - [serve-handler](https://npm.io/package/serve-handler.md) ^6.1.3 - [path-is-inside](https://npm.io/package/path-is-inside.md) ^1.0.2 - [path-to-regexp](https://npm.io/package/path-to-regexp.md) ^6.2.1 - [fast-url-parser](https://npm.io/package/fast-url-parser.md) ^1.1.3 - [markdown-it-ins](https://npm.io/package/markdown-it-ins.md) ^2.0.0 - [markdown-it-sub](https://npm.io/package/markdown-it-sub.md) ^1.0.0 - [markdown-it-sup](https://npm.io/package/markdown-it-sup.md) ^1.0.0 - [markdown-it-abbr](https://npm.io/package/markdown-it-abbr.md) ^1.0.4 - [markdown-it-mark](https://npm.io/package/markdown-it-mark.md) ^2.0.0 - [markdown-it-attrs](https://npm.io/package/markdown-it-attrs.md) ^4.1.6 - [markdown-it-emoji](https://npm.io/package/markdown-it-emoji.md) ^1.4.0 - [markdown-it-prism](https://npm.io/package/markdown-it-prism.md) ^2.2.1 - [connect-multiparty](https://npm.io/package/connect-multiparty.md) ^2.2.0 - [markdown-it-anchor](https://npm.io/package/markdown-it-anchor.md) ^8.6.7 - [content-disposition](https://npm.io/package/content-disposition.md) ^0.5.4 - [markdown-it-deflist](https://npm.io/package/markdown-it-deflist.md) ^2.0.3 - [markdown-it-footnote](https://npm.io/package/markdown-it-footnote.md) ^3.0.2 - [markdown-it-container](https://npm.io/package/markdown-it-container.md) ^2.0.0 - [axios-cookiejar-support](https://npm.io/package/axios-cookiejar-support.md) ^4.0.6 - [markdown-it-replace-link](https://npm.io/package/markdown-it-replace-link.md) ^1.1.0 - [@fortawesome/fontawesome-free](https://npm.io/package/@fortawesome/fontawesome-free.md) ^6.1.2 ## Recent versions - 2.708.4 (latest) — 2026-01-16 - 2.67.7 — 2024-05-22 - 2.67.6 — 2023-08-22 - 2.67.5 — 2023-08-16 - 2.5.3 — 2023-07-20 - 2.5.2 — 2023-07-05 - 2.5.1 — 2023-06-14 - 2.5.0 — 2023-06-14 ## README # Napier Client Japanese document is [here](README_jp.md) Napier is on demand proxy system, using websocket. Napier client is a client for connecting to the Napier server. ## Quick start ### Install #### Command-line client You can install a command line client like this: ```shell npm install -g napier-client ``` #### GUI client ![Napier Client GUI](https://www.napier-net.com/assets/ss_login_button.jpg) The GUI client is released. * Windows (x64) * Mac(x64) * Mac(arm64) * Debian(amd64) * Debian(arm64) Download and launch the installer to install. ### Start up #### Start command line client To connect the client, ```shell $ napier-client ``` Run like. The boot options are: ``` Usage: napier-client [options] [profileName] Arguments: profileName profile name (default: "default") Options: --config config file --user user name --password password --url Napier server URL --local-port local port --re-connect re-connect server --web-server start web server --server-config web server config file --document-root web server document root --index list index ``` Of these, the ones that must be specified are `--user`, `--password`, and `--host`. Options specified on the command line are ```javascript { "url": "https://www.napier-net.com", "localPort": 4001, "reConnect": true, "webServer": false, "user": "****", "password": "****", "documentRoot": "." } ``` It is also possible to store it in a file and specify it with `--config`. At the end of the command line is the "profile" specification. If not specified, 'default' will be specified. `--web-server` will start the embedded web server. A web server with the directory specified by `--document-root` as the document root will be started and accessible from the outside via the proxy. Note that if `--document-root` is not specified, the directory where the client is started will be the document root. #### Start GUI client It is the same as starting a normal application. Options specified in the command line version can be set within the client. ## Service site We have created a [service site](https://www.napier-net.com) so you can try it out right away. You can try it by starting the client after accessing the site and performing user registration. For information on how to use the service site, please access the service site. ## Appendix ### About the default profile If you specify the default profile (= if you do not specify a profile), it depends on the server settings how the URL will be proxied, but in normal settings: ``` (http|https)://./ ``` (This is the default setting of the server). For [Napier-NET](https://www.napier-net.com/), ``` (http|https)://.napier-net.com/ ``` For Napier-NET, the HTTPS certificate for the default profile will be that of Napier-NET. This certificate is a wildcard certificate. ### About the embedded web server Specifying `--web-server` on the command line will start the embedded web server. The embedded web server configuration is assumed to be in the file specified by `--server-config`. If not, the default setting will be used. Currently available are: | key | meaning | default | |------|-----|-----------| | public | same as documentRoot | '.' | | index | Whether to display the directory index | false | | symlinks | Whether to follow symbolic links | false | in other words ```javascript { "public": ".", "index": false, "symlinks": false } ``` It will be the same as if a file written with is specified. The embedded web server will automatically render HTML renderings for MarkDown files (extension .md). The embedded web server will open the port specified by `localPort`. That is, it has local portals in addition to the global portals opened by Napier. You can connect other Napier clients to this port if you want. The current web server only processes `GET`, so files cannot be changed or deleted from the outside, but files under `documentRoot` can be **referenced**, Don't put files that can't be made public. This web server is very simple. The usage scene we envision is for exchanging files among friends. If you need a more full-fledged web service, please launch a suitable application separately. --- _Source: https://npm.io/package/napier-client · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._