frely-cli 0.3.5 → 0.3.7

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/NOTICE

@@ -0,0 +1,6 @@
+Frely CLI
+Copyright 2026 FrelyHQ.
+
+The Frely name, Frely logos, and Frely product names are trademarks of
+their respective owner and are not licensed under the Apache License 2.0.
+See TRADEMARKS.md for permitted descriptive use.

package/README.md

@@ -10,6 +10,11 @@ install -> frely login -> frely mcp setup -> add MCP URL to ChatGPT
 
 There is no separate `friday-local` project. Local MCP execution belongs to `frely-cli`.
 
+This repository contains the open-source Frely client and local MCP runtime.
+The hosted Friday Relay control plane remains a separate service dependency.
+See [`CONTRIBUTING.md`](CONTRIBUTING.md) for development guidance and
+[`SECURITY.md`](SECURITY.md) for private vulnerability reporting.
+
 ## Quick install
 
 After `frely-cli` is published, Frely can serve the repository `install.sh` as:
@@ -18,11 +23,53 @@ After `frely-cli` is published, Frely can serve the repository `install.sh` as:
 curl -fsSL https://app.frely.cloud/install.sh | sh
 ```
 
-The installer requires Node.js 22 or newer and installs `frely-cli@latest` through npm.
+The package requires Node.js 22 or newer. The installer installs `frely-cli@latest` through npm.
+
+## Install or update with npm
+
+To install or update to the latest release, use:
+
+```sh
+npm install --global frely-cli@latest
+```
+
+To install or update to a specific release, replace `latest` with the release version. For example:
+
+```sh
+npm install --global frely-cli@0.3.6
+```
+
+## Update an existing installation
+
+If you installed `frely-cli` with the official installer, run the [Quick install](#quick-install) installer again. It replaces the global package with the latest `frely-cli` release. If you installed the package directly with npm, run one of the commands in [Install or update with npm](#install-or-update-with-npm) again.
+
+If multiple `frely` executables are installed, list the candidates and check the npm global installation:
+
+```sh
+type -a frely
+npm prefix --global
+"$(npm prefix --global)/bin/frely" --version
+```
+
+Your shell uses the first `frely` path in `PATH`. If that path is not the npm global bin directory, put `$(npm prefix --global)/bin` earlier in `PATH` and run `frely --version` again.
+
+If the background Device Relay service is running, restart it after the update so it loads the new CLI version:
+
+```sh
+frely mcp service stop
+frely mcp service start
+```
+
+Verify the update:
+
+```sh
+frely --version
+frely doctor
+```
 
 ## Install from a local checkout
 
-The package requires Node.js 22 or newer. To install the current source checkout with Bun:
+To install the current source checkout with Bun:
 
 ```sh
 cd /path/to/frely-cli
@@ -44,7 +91,9 @@ bun pm trust keytar
 bun install
 ```
 
-The repository currently has an npm lockfile rather than a committed Bun lockfile. The first `bun install` may create `bun.lock`; handle that file according to the repository's lockfile policy.
+The repository uses npm as the canonical package manager for CI and releases
+and commits `package-lock.json`. Bun can be used for local development; keep
+the lockfiles synchronized when changing dependencies.
 
 ## First use
 
@@ -53,6 +102,8 @@ frely login
 frely mcp setup --workspace /path/to/project
 ```
 
+`frely login` starts a Better Auth device-authorization flow, opens the Frely approval page in your browser, and waits for explicit approval. The resulting OAuth access/refresh tokens are stored in the operating-system credential store; they are never written to the CLI config file, command line, URL, or logs. The CLI keeps accepting an existing legacy session cookie during the transition.
+
 `mcp setup` performs three client-side steps:
 
 1. enrolls this machine with the logged-in Frely account;
@@ -73,6 +124,39 @@ Or show ChatGPT-oriented instructions with:
 frely mcp chatgpt
 ```
 
+## Local model sharing
+
+`frely-cli` can publish a loopback OpenAI-compatible runtime as a Frely personal Provider. Ollama is the default driver.
+
+```sh
+frely provider share ollama
+```
+
+Default Ollama endpoint: `http://127.0.0.1:11434/v1`.
+
+Custom endpoint and model selection:
+
+```sh
+frely provider share openai-compatible \
+  --url http://127.0.0.1:8080/v1 \
+  --models model-a,model-b \
+  --slot <personal-provider-slot-id> \
+  --name "Local GPU"
+```
+
+Requirements: Frely login, one empty active personal Provider slot, loopback HTTP, OpenAI-compatible `/v1`. Model names cannot contain whitespace or `/`.
+
+The command creates a server-managed `openai-compatible` personal Provider, stores the local endpoint in owner-only CLI state, starts the Device Relay service, signs a Provider credential with the device Ed25519 key, configures CPA, and enables the declared models. Existing Frely Access Point and API-key flows consume the Provider.
+
+Provider inspection and recovery:
+
+```sh
+frely provider list
+frely provider finalize <provider-id>
+```
+
+`finalize` resumes CPA setup for a Provider left in a prepared state.
+
 ## Commands
 
 ```text
@@ -81,6 +165,9 @@ frely logout
 frely whoami
 frely status [--json]
 frely doctor [--json]
+frely provider share [ollama|openai-compatible] [--url <loopback-v1-url>] [--models <a,b>] [--slot <slot-id>] [--name <name>]
+frely provider list [--json]
+frely provider finalize <provider-id>
 frely mcp setup [--workspace <path>]
 frely mcp url [--json]
 frely mcp status [--json]
@@ -152,6 +239,12 @@ Filesystem tools are constrained to the selected workspace, reject symlink escap
 
 ## Current server dependency
 
-The CLI side of installation, account login, device enrollment, MCP URL discovery, background service lifecycle, Device Relay WebSocket transport, multiplexing, reconnection, and local MCP execution is implemented here.
+The CLI side of installation, account login, device enrollment, MCP URL discovery, background service lifecycle, Device Relay WebSocket transport, multiplexing, reconnection, local MCP execution, local model discovery, and loopback Provider forwarding is implemented here.
+
+A Frely Relay deployment must implement the device provisioning endpoints, Device Relay WebSocket host, private MCP ingress, local Provider ingress, and personal Provider control flow. The private MCP URL is the ChatGPT-side bearer credential. Local Provider credentials are device-key signatures stored by CPA.
+
+## License and trademarks
 
-A Frely Relay deployment must implement the three provisioning endpoints, Device Relay WebSocket host, and public private-URL MCP ingress before `frely mcp setup` can produce a working ChatGPT connection. The private MCP URL is the ChatGPT-side bearer credential, so no separate ChatGPT MCP authentication service is required.
+`frely-cli` is licensed under the Apache License 2.0; see [`LICENSE`](LICENSE).
+The Frely name, logos, and product names are not licensed as trademarks; see
+[`TRADEMARKS.md`](TRADEMARKS.md).

package/TRADEMARKS.md

@@ -0,0 +1,10 @@
+# Trademarks
+
+The Apache License 2.0 applies to the `frely-cli` source code. It does not
+grant permission to use the Frely name, logos, or other brand assets as a
+trademark.
+
+You may use “Frely” descriptively when referring to the upstream project or
+when identifying an unmodified copy of this software. Modified distributions
+should use a distinct product name and must not imply that Frely endorses or
+supports the modified distribution.

package/dist/auth.d.ts

@@ -3,6 +3,12 @@ export interface PublicUser {
     email: string;
     name?: string | null;
 }
+export interface AuthCredential {
+    scheme: "bearer" | "cookie";
+    value: string;
+    refreshToken?: string;
+    expiresAt?: number;
+}
 export interface AuthSnapshot {
     configured: boolean;
     relayUrl?: string;
@@ -10,17 +16,28 @@ export interface AuthSnapshot {
     credentialStored: boolean;
     configPath: string;
     configMode?: number;
+    authMethod?: "bearer" | "cookie";
 }
 export declare function authConfigPath(): string;
 export declare function normalizeRelayUrl(value?: string): string;
-export declare function login(email: string, password: string, relayInput?: string): Promise<PublicUser>;
+/** Device authorization is the default. The 3-argument form remains only for old callers/tests. */
+export declare function login(relayOrEmail?: string, legacyPassword?: string, legacyRelayInput?: string): Promise<PublicUser>;
+export declare function loginDevice(relayInput?: string, notify?: (details: {
+    verificationUri: string;
+    userCode: string;
+}) => void): Promise<{
+    user: PublicUser;
+    verificationUri: string;
+    userCode: string;
+}>;
 export declare function whoami(): Promise<PublicUser>;
 export declare function requireLogin(): Promise<{
     config: {
         relayUrl: string;
     };
     user: PublicUser;
-    cookie: string;
+    credential: AuthCredential;
+    cookie?: string;
 }>;
 export declare function logout(): Promise<void>;
 export declare function inspectAuth(): Promise<AuthSnapshot>;