@portl/cli 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/LICENSE ADDED
@@ -0,0 +1,201 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ APPENDIX: How to apply the Apache License to your work.
179
+
180
+ To apply the Apache License to your work, attach the following
181
+ boilerplate notice, with the fields enclosed by brackets "[]"
182
+ replaced with your own identifying information. (Don't include
183
+ the brackets!) The text should be enclosed in the appropriate
184
+ comment syntax for the file format. We also recommend that a
185
+ file or class name and description of purpose be included on the
186
+ same "printed page" as the copyright notice for easier
187
+ identification within third-party archives.
188
+
189
+ Copyright 2025 Portl Inc.
190
+
191
+ Licensed under the Apache License, Version 2.0 (the "License");
192
+ you may not use this file except in compliance with the License.
193
+ You may obtain a copy of the License at
194
+
195
+ http://www.apache.org/licenses/LICENSE-2.0
196
+
197
+ Unless required by applicable law or agreed to in writing, software
198
+ distributed under the License is distributed on an "AS IS" BASIS,
199
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200
+ See the License for the specific language governing permissions and
201
+ limitations under the License.
package/README.md ADDED
@@ -0,0 +1,348 @@
1
+ # Portl CLI
2
+
3
+ Interactive command-line tool for setting up and managing your Portl infrastructure connections.
4
+
5
+ ## Installation
6
+
7
+ ### Global Installation (Recommended)
8
+
9
+ ```bash
10
+ npm install -g @portl/cli
11
+ ```
12
+
13
+ After installation, the `portl` command will be available globally.
14
+
15
+ ### Local Development
16
+
17
+ From the monorepo root:
18
+
19
+ ```bash
20
+ npm install
21
+ npm run cli -- init
22
+ ```
23
+
24
+ Or directly:
25
+
26
+ ```bash
27
+ node portl-cli/bin/portl.js init
28
+ ```
29
+
30
+ ### Creating Global Alias (Development)
31
+
32
+ To use `portl` command during development:
33
+
34
+ ```bash
35
+ # From the portl-cli directory
36
+ npm link
37
+ ```
38
+
39
+ Now you can use `portl` from anywhere:
40
+
41
+ ```bash
42
+ portl init
43
+ portl connect supabase
44
+ portl --help
45
+ ```
46
+
47
+ ## Commands
48
+
49
+ ### `portl init`
50
+
51
+ Interactive setup wizard that walks you through connecting your infrastructure:
52
+
53
+ - **Database**: PostgreSQL, MySQL, MongoDB, Supabase, Neon, PlanetScale
54
+ - **Storage**: S3, Cloudflare R2, and compatible providers
55
+ - **Payments**: Stripe, Mercado Pago
56
+ - **CI/CD**: GitHub Actions
57
+
58
+ **Features:**
59
+ - Conversational yes/no flow
60
+ - Auto-detects API keys from environment
61
+ - Executes OAuth in real-time (when API key available)
62
+ - Generates `portl.config.json` and `.env.portl`
63
+
64
+ **Example:**
65
+ ```bash
66
+ portl init
67
+ ```
68
+
69
+ ### `portl connect supabase`
70
+
71
+ Complete OAuth authentication for Supabase:
72
+
73
+ ```bash
74
+ portl connect supabase
75
+ portl connect supabase --project-id my-app
76
+ portl connect supabase --no-open # Don't auto-open browser
77
+ ```
78
+
79
+ ### `portl bootstrap`
80
+
81
+ Generate integration configurations:
82
+
83
+ #### GitHub Actions Workflow
84
+ ```bash
85
+ portl bootstrap github-actions --repository owner/repo
86
+ ```
87
+
88
+ #### Stripe Webhooks
89
+ ```bash
90
+ portl bootstrap stripe-webhook --secret-key sk_test_xxx
91
+ ```
92
+
93
+ #### Mercado Pago Webhooks
94
+ ```bash
95
+ portl bootstrap mercadopago-webhook
96
+ ```
97
+
98
+ ## Configuration Files
99
+
100
+ ### `portl.config.json`
101
+
102
+ Main configuration file generated by `portl init`:
103
+
104
+ ```json
105
+ {
106
+ "projectId": "my-app",
107
+ "integrations": [
108
+ {
109
+ "providerId": "supabase",
110
+ "category": "database",
111
+ "config": {
112
+ "setupMode": "oauth",
113
+ "projectRef": "abc123"
114
+ }
115
+ }
116
+ ]
117
+ }
118
+ ```
119
+
120
+ ### `.env.portl`
121
+
122
+ Environment variables template:
123
+
124
+ ```bash
125
+ # Portl Environment Variables
126
+ # Generated by: portl init
127
+
128
+ # supabase (database)
129
+ PORTL_DB_SUPABASE_SETUP_MODE=oauth
130
+ PORTL_DB_SUPABASE_PROJECT_REF=abc123
131
+
132
+ # r2 (storage)
133
+ PORTL_STORAGE_R2_ACCOUNT_ID=your-account-id
134
+ PORTL_STORAGE_R2_ENDPOINT=https://account-id.r2.cloudflarestorage.com
135
+ PORTL_STORAGE_R2_ACCESS_KEY_ID=your-key
136
+ PORTL_STORAGE_R2_SECRET_ACCESS_KEY=your-secret
137
+ PORTL_STORAGE_R2_BUCKET=your-bucket
138
+ ```
139
+
140
+ **Important:** Copy values from `.env.portl` to your `.env` file.
141
+
142
+ ## Supported Providers
143
+
144
+ ### Databases
145
+ - ✅ **Supabase** - PostgreSQL + Auth + Storage (OAuth or manual)
146
+ - ✅ **Neon** - Serverless PostgreSQL
147
+ - ✅ **PostgreSQL** - Self-hosted or managed
148
+ - ✅ **MySQL** - Self-hosted or managed
149
+ - ✅ **MongoDB** - Document database
150
+ - ✅ **PlanetScale** - Serverless MySQL
151
+
152
+ ### Storage
153
+ - ✅ **Cloudflare R2** - S3-compatible, zero egress fees
154
+ - ✅ **Generic S3** - AWS S3 or compatible providers
155
+
156
+ ### Payments
157
+ - ✅ **Stripe** - Payment processing
158
+ - ✅ **Mercado Pago** - Latin America payments
159
+
160
+ ### CI/CD
161
+ - ✅ **GitHub Actions** - Automated workflows
162
+
163
+ ## OAuth Flow
164
+
165
+ When you select OAuth authentication (e.g., Supabase):
166
+
167
+ 1. **With API Key** (Automatic):
168
+ ```bash
169
+ # Set API key first
170
+ export ACCESS_API_KEY=your-key
171
+
172
+ # Run init
173
+ portl init
174
+ # Select Database → Supabase → OAuth
175
+ # Browser opens automatically
176
+ # OAuth completes immediately ✓
177
+ ```
178
+
179
+ 2. **Without API Key** (Manual):
180
+ ```bash
181
+ # Run init
182
+ portl init
183
+ # Select Database → Supabase → OAuth
184
+ # Message: "Run portl connect supabase after init"
185
+
186
+ # After init, set API key and connect
187
+ export ACCESS_API_KEY=your-key
188
+ portl connect supabase
189
+ ```
190
+
191
+ ## Environment Variables
192
+
193
+ ### `ACCESS_API_KEY`
194
+
195
+ Required for live OAuth connections and backend validation.
196
+
197
+ **Set via environment:**
198
+ ```bash
199
+ export ACCESS_API_KEY=your-api-key-here
200
+ ```
201
+
202
+ **Or in `.env` file:**
203
+ ```bash
204
+ # .env
205
+ ACCESS_API_KEY=your-api-key-here
206
+ ```
207
+
208
+ The CLI auto-detects this key and enables OAuth flows automatically.
209
+
210
+ ### `PORTL_OAUTH_CLI_REDIRECT_URI`
211
+
212
+ Optional. Override the default OAuth redirect URI:
213
+
214
+ ```bash
215
+ export PORTL_OAUTH_CLI_REDIRECT_URI=http://localhost:7131/oauth/callback
216
+ ```
217
+
218
+ ## Troubleshooting
219
+
220
+ ### Command not found: portl
221
+
222
+ **Solution 1:** Install globally
223
+ ```bash
224
+ npm install -g @portl/cli
225
+ ```
226
+
227
+ **Solution 2:** Use npm link (development)
228
+ ```bash
229
+ cd portl-cli
230
+ npm link
231
+ ```
232
+
233
+ **Solution 3:** Use direct path
234
+ ```bash
235
+ node /path/to/portl-cli/bin/portl.js init
236
+ ```
237
+
238
+ ### OAuth timeout
239
+
240
+ If OAuth doesn't complete:
241
+
242
+ ```bash
243
+ # Increase timeout (default: 2 minutes)
244
+ portl connect supabase --no-wait # Skip waiting
245
+ # Then manually verify connection in dashboard
246
+ ```
247
+
248
+ ### Can't read browser opened status
249
+
250
+ The CLI tries to auto-open your browser. If it fails, copy the URL manually:
251
+
252
+ ```bash
253
+ 🔗 OAuth URL:
254
+ https://api.supabase.com/v1/oauth/authorize?...
255
+
256
+ âš  Could not open browser automatically
257
+ ℹ Please open the URL above in your browser
258
+ ```
259
+
260
+ ## Examples
261
+
262
+ ### Full Setup Flow
263
+
264
+ ```bash
265
+ # Install CLI
266
+ npm install -g @portl/cli
267
+
268
+ # Set API key (optional, enables OAuth)
269
+ export ACCESS_API_KEY=your-key-here
270
+
271
+ # Run interactive setup
272
+ portl init
273
+
274
+ # Follow prompts:
275
+ # Project name: my-awesome-app
276
+ # Database? (Y/n): y
277
+ # Provider: Supabase
278
+ # OAuth? (Y/n): y
279
+ # → Browser opens, auth completes automatically ✓
280
+ # Storage? (y/N): y
281
+ # Provider: Cloudflare R2
282
+ # → Enter credentials
283
+ # Payments? (y/N): n
284
+ # CI/CD? (y/N): n
285
+
286
+ # Files generated:
287
+ # ✓ portl.config.json
288
+ # ✓ .env.portl
289
+
290
+ # Copy environment variables
291
+ cat .env.portl >> .env
292
+
293
+ # Install SDK
294
+ npm install @portl/sdk
295
+
296
+ # Start building!
297
+ ```
298
+
299
+ ### Quick Start Without OAuth
300
+
301
+ ```bash
302
+ portl init
303
+
304
+ # Database? y
305
+ # Provider: PostgreSQL
306
+ # Host: localhost
307
+ # Port: 5432
308
+ # Database: mydb
309
+ # User: postgres
310
+ # Password: ****
311
+
312
+ # Storage? n
313
+ # Payments? n
314
+ # CI/CD? n
315
+
316
+ # Done!
317
+ ```
318
+
319
+ ## Development
320
+
321
+ ### Running Tests
322
+
323
+ ```bash
324
+ npm test
325
+ ```
326
+
327
+ ### Building
328
+
329
+ ```bash
330
+ npm run build
331
+ ```
332
+
333
+ ### Publishing
334
+
335
+ ```bash
336
+ npm version patch # or minor, major
337
+ npm publish --access public
338
+ ```
339
+
340
+ ## License
341
+
342
+ Apache-2.0
343
+
344
+ ## Links
345
+
346
+ - [Documentation](https://portl.finns.lat/docs)
347
+ - [GitHub](https://github.com/your-org/portl)
348
+ - [Issues](https://github.com/your-org/portl/issues)