Registry / auth-security / solid-auth-cli

solid-auth-cli

library1.0.15jsnpmunverified

solid-auth-cli is a Node.js and command-line client library designed to facilitate persistent authentication with Solid Pods. It provides an API that mirrors solid-auth-client, enabling scripts to function in both browser (via solid-auth-client) and server-side/CLI environments (via solid-auth-cli) with minimal code changes. The current stable version is 1.0.15. While a specific release cadence isn't detailed, its versioning suggests a mature and stable 1.x branch. A key differentiator is its support for persistent logins using configuration files or environment variables, making it ideal for automated scripts or server-side applications that interact with Solid resources. It also offers a custom fetch implementation that can be integrated with rdflib.js (version 0.19.1 or newer) for graph data manipulation, or used directly for fetching resources via standard REST APIs, allowing programmatic interaction with the Solid ecosystem.

auth-security http-networking devops web-framework

npm install solid-auth-cli

package ↗

INSTALL

IMPORT

SIG · SOLID-AUTH-CLI

solid-auth-cli

auth-securityjavascriptv1.0.15

Install

—

Import

—

Disk

—

Pass rate

0/ 6

Env Coverage0 / 6

glibc

18–22

musl

18–22

Install & Compatibility

Where this runs

tested against v? · npm install

Install × environment matrix

Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux

musl

node 18–226 runs

build_error

glibc

node 18–226 runs

build_error

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

auth

✓ const auth = require('solid-auth-cli')

✗ import auth from 'solid-auth-cli'

solid-auth-cli is primarily a CommonJS module. Direct ES Module 'import' syntax is not supported without transpilation or a wrapper.

✓ auth.login()

✗ import { login } from 'solid-auth-cli'

The login method is accessed as a property of the main module export, not as a named export.

fetch

✓ auth.fetch(resource)

✗ import { fetch } from 'solid-auth-cli'

The fetch method is accessed as a property of the main module export, not as a named export. This custom fetch function provides authenticated Solid requests.

This quickstart demonstrates how to log in persistently, fetch an authenticated resource from a Solid Pod, and check its content.

const solid = { auth:require('solid-auth-cli') } const resource = "https://example.com/private/hidden.ttl" // Replace with your Solid Pod resource const expected = "only the owner" console.log("logging in ...") login().then( session => { console.log(`logged in as <${session.webId}>`) solid.auth.fetch(resource).then( response => { if (!response.ok) console.log(response.status+" "+response.statusText) response.text().then( content => { if( content.match(new RegExp(expected)) ) console.log("ok: content matches expected pattern.") else console.log("Got something, but not the right thing.") },e => console.log("Error parsing : "+e)) },e => console.log("Error fetching : "+e)) },e => console.log("Error logging in : "+e)) async function login() { // This example attempts a silent login from a previous session, then prompts if needed. // For a non-interactive script, ensure credentials are set via env vars or config file. var session = await solid.auth.currentSession() if (!session) { // You would typically configure IDP, username, password via env vars or a config file for CLI usage session = await solid.auth.login() // Will attempt to read ~/.solid-auth-cli-config.json or env vars } return session; }

solid-auth-cli --version

Debug

Known issues

gotchaWhen integrating with rdflib.js, solid-auth-cli requires rdflib.js version 0.19.1 or later due to API changes in rdflib's fetcher initialization.

fix

Ensure rdflib.js is installed at version 0.19.1 or higher. Run `npm install rdflib@^0.19.1` or update your `package.json`.

affects: >=1.0.0

gotchasolid-auth-cli is a CommonJS module. Attempting to use `import` statements directly in an ES Module context will fail unless Node.js is configured for interoperability or a build step transpiles it.

fix

Use `const solid = require('solid-auth-cli')` or ensure your Node.js environment is configured for CommonJS. If you must use ESM, consider dynamic `import()` or a wrapper.

affects: >=1.0.0

Errors

Common errors & fixes

TypeError: rdflib_1.default.fetcher is not a function

Attempting to use `rdflib.js` with `solid-auth-cli` when `rdflib.js` is an older, incompatible version (prior to 0.19.1).

fix

Upgrade `rdflib.js` to version 0.19.1 or newer: `npm install rdflib@^0.19.1`.

ReferenceError: require is not defined

You are attempting to use the `require()` function in an ES Module (ESM) context in Node.js, where `import` is expected.

fix

Ensure your project's `package.json` specifies `"type": "commonjs"`, or rename your file to `.cjs`. Alternatively, wrap `solid-auth-cli` in a CJS file or use dynamic `import()` if truly in an ESM context.

Error logging in: No Identity Provider, username, or password found.

The `login()` method was called without sufficient credentials or configuration. It expects either an object with `idp`, `username`, `password`, a path to a credentials JSON file, or environment variables `SOLID_IDP`, `SOLID_USERNAME`, `SOLID_PASSWORD` to be set.

fix

Provide credentials directly to `login({ idp: '...', username: '...', password: '...' })`, or create a `~/.solid-auth-cli-config.json` file, or set the necessary environment variables before running your script.

Upgrade

Version history

1.0.15latest on npm

Audit

Dependencies

rdfliboptionalRequired for integration with rdflib.js for RDF graph manipulation, specifically version 0.19.1 or newer.

Agent activity

14 hits · last 30 days

node

OpenAI (training)

Resources

packagehttps://www.npmjs.com/package/solid-auth-cli ↗