iflow-comm 1.0.1 → 1.0.3

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 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 2025 Google LLC
+
+   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/README.md

@@ -81,7 +81,7 @@ brew install iflow-cli
 
 * Using Node.js installation
 ```shell
-npm i -g @iflow-ai/iflow-cli
+npm i -g iflow-comm
 ```
 
 This command automatically installs all necessary dependencies for your terminal.
@@ -90,8 +90,8 @@ This command automatically installs all necessary dependencies for your terminal
 1. Go to https://nodejs.org/en/download to download the latest Node.js installer
 2. Run the installer to install Node.js
 3. Restart your terminal: CMD or PowerShell
-4. Run `npm install -g @iflow-ai/iflow-cli` to install iFlow CLI
-5. Run `iflow` to start iFlow CLI
+4. Run `npm install -g iflow-comm` to install iFlow CLI
+5. Run `iflow-comm` to start iFlow CLI
 
 If you are in China Mainland, you can use the following command to install iFlow CLI:
 1. Go to https://cloud.iflow.cn/iflow-cli/nvm-setup.exe to download the latest nvm installer
@@ -100,44 +100,44 @@ If you are in China Mainland, you can use the following command to install iFlow
 4. Run `nvm node_mirror https://npmmirror.com/mirrors/node/` and `nvm npm_mirror https://npmmirror.com/mirrors/npm/`
 5. Run `nvm install 22` to install Node.js 22
 6. Run `nvm use 22` to use Node.js 22
-7. Run `npm install -g @iflow-ai/iflow-cli` to install iFlow CLI
-8. Run `iflow` to start iFlow CLI
+7. Run `npm install -g iflow-comm` to install iFlow CLI
+8. Run `iflow-comm` to start iFlow CLI
 
 ## 🗑️ Uninstall
 ```shell
-npm uninstall -g @iflow-ai/iflow-cli
+npm uninstall -g iflow-comm
 ```
 
 ## 🔑 Authentication
 
-iFlow CLI supports OpenAI-compatible APIs for authentication and model access.
+iFlow offers two authentication options:
 
-To configure your API credentials, edit the settings file in `~/.iflow/settings.json`:
+1. **Recommended**: Use iFlow's native authentication
+2. **Alternative**: Connect via OpenAI-compatible APIs
 
-```json
-{
-    "selectedAuthType": "openai-compatible",
-    "apiKey": "your_api_key",
-    "baseUrl": "https://api.openai.com/v1",
-    "modelName": "gpt-4"
-}
-```
+![iFlow CLI Login](./assets/login.jpg)
 
-You can also set these values using environment variables:
+Choose option 1 to login directly, which will open iFlow account authentication in a web page. After completing authentication, you can use it for free.
 
-```bash
-export IFLOW_apiKey="your_api_key"
-export IFLOW_baseUrl="https://api.openai.com/v1"
-export IFLOW_modelName="gpt-4"
-iflow
-```
+![iFlow CLI Web Login](./assets/web-login.jpg)
+
+If you are in an environment like a server where you cannot open a web page, please use option 2 to login.
+
+To get your API key:
+1. Register for an iFlow account
+2. Go to your profile settings or click [this direct link](https://iflow.cn/?open=setting)
+3. Click "Reset" in the pop-up dialog to generate a new API key
+
+![iFlow Profile Settings](./assets/profile-settings.jpg)
+
+After generating your key, paste it into the terminal prompt to complete setup.
 
 ## 🚀 Getting Started
 
 To launch iFlow CLI, navigate to your workspace in the terminal and type:
 
 ```shell
-iflow
+iflow-comm
 ```
 
 ### Starting New Projects
@@ -146,7 +146,7 @@ For new projects, simply describe what you want to create:
 
 ```shell
 cd new-project/
-iflow
+iflow-comm
 > Create a web-based Minecraft game using HTML
 ```
 
@@ -156,7 +156,7 @@ For existing codebases, begin with the `/init` command to help iFlow understand
 
 ```shell
 cd project1/
-iflow
+iflow-comm
 > /init
 > Analyze the requirements according to the PRD document in requirement.md file, and output a technical document, then implement the solution.
 ```
@@ -229,10 +229,11 @@ Here is a settings demo file:
 ```json
 {
     "theme": "Default",
-    "selectedAuthType": "openai-compatible",
-    "apiKey": "your_api_key",
-    "baseUrl": "https://api.openai.com/v1",
-    "modelName": "gpt-4"
+    "selectedAuthType": "iflow",
+    "apiKey": "your iflow key",
+    "baseUrl": "https://apis.iflow.cn/v1",
+    "modelName": "Qwen3-Coder",
+    "searchApiKey": "your iflow key"
 }
 ```
 

package/bin/{iflow-comm.js → iflow-comm.cjs}

@@ -8,13 +8,14 @@
 const { spawn } = require('child_process');
 const path = require('path');
 
-// Get the path to iflow executable
-const iflowPath = path.join(__dirname, '../node_modules/.bin/iflow');
+// Get the path to iflow entry point (local bundle)
+const entryPath = path.join(__dirname, '../bundle/entry.js');
 
-// Spawn iflow with all arguments
-const child = spawn(iflowPath, process.argv.slice(2), {
+// Spawn iflow with all arguments using Node.js
+const child = spawn('node', [entryPath, ...process.argv.slice(2)], {
   stdio: 'inherit',
-  shell: process.platform === 'win32'
+  shell: false,
+  windowsHide: true
 });
 
 // Handle exit
@@ -25,4 +26,4 @@ child.on('exit', (code) => {
 child.on('error', (err) => {
   console.error('Failed to start iflow:', err.message);
   process.exit(1);
-});
+});