@grayspar/cli 0.0.0-stage → 0.0.1

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 [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/README.md

@@ -1,3 +1,77 @@
-# Temporary Holding Version
+# Grayspar CLI
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+The cloud for small software. Deploy your applications with one command, and share them with exactly the people you choose.
+
+Grayspar builds your app, gives it its own address, and keeps it private to you until you share it. The people you share it with sign in with Google, GitHub or a code sent to their email, and the app opens. Your app needs no login code of its own.
+
+## Install
+
+```sh
+npm install -g @grayspar/cli
+```
+
+It needs Node 22 or newer. To run it once with nothing installed, use `npx @grayspar/cli deploy`.
+
+## Deploy
+
+```sh
+grayspar login
+grayspar deploy
+```
+
+Run `grayspar deploy` in your app's directory. The first deploy asks for the project's name, which is also its address. Grayspar finds the services in it, a web front end and an API for example, builds each one and answers with the address where it runs.
+
+A service's files reset on every deploy. To keep a folder, name it when you deploy:
+
+```sh
+grayspar deploy --volume app=/app/data
+```
+
+A service at the root of your directory is called `app`, and one in a subfolder takes that folder's name.
+
+## Share
+
+```sh
+grayspar access add alice@company.com
+```
+
+Alice gets an email with the link. Name people one by one, or a whole company at once with `@company.com`.
+
+## For scripts and agents
+
+Every command answers in JSON with `--json`, and `--yes` accepts what the CLI would otherwise ask. A command that needs an answer it cannot ask for refuses and names the flag that supplies it, so a script or an AI agent can run Grayspar without a terminal.
+
+## Commands
+
+| Command     | What it does                                                                    |
+| ----------- | ------------------------------------------------------------------------------- |
+| `login`     | sign in to Grayspar from this machine                                           |
+| `logout`    | forget the saved sign-in on this machine                                        |
+| `whoami`    | show who this machine is signed in as                                           |
+| `deploy`    | build a project folder and put it online                                        |
+| `project`   | work with your projects                                                         |
+| `access`    | control who can open a project                                                  |
+| `open-path` | paths anyone can reach without signing in, such as webhooks                     |
+| `env`       | set a project's environment variables                                           |
+| `volume`    | keep a folder across deploys                                                    |
+| `service`   | change where a service answers and how it is built                              |
+| `link`      | bind this folder to a project                                                   |
+| `unlink`    | unbind this folder from its project                                             |
+| `status`    | show what a project is doing                                                    |
+| `logs`      | show what a service printed while running, or with `--build` the last build log |
+| `restart`   | run a service again in place, keeping its volumes                               |
+
+`grayspar <command> --help` shows each command's options.
+
+## Versions
+
+The CLI has a version of its own. It moves when the CLI itself changes, so a new Grayspar feature often reaches you with no update at all.
+
+## Links
+
+- [grayspar.com](https://grayspar.com)
+- [Privacy Policy](https://grayspar.com/privacy/)
+- [Terms of Service](https://grayspar.com/terms/)
+- Support: support@grayspar.com
+
+Licensed under the Apache License 2.0.

package/dist/commands/access.js

@@ -0,0 +1,103 @@
+/* A target starting with @ is a company and anything else is an address, so one command adds both,
+   the way one box on the dashboard does. */
+import { Command, Option } from 'commander';
+import { dataOrThrow, signedInClient } from '../lib/client.js';
+import { commandAction } from '../lib/command-helpers.js';
+import { CliError } from '../lib/errors.js';
+import { printResult } from '../lib/output.js';
+import { resolveProject } from '../lib/resolve-project.js';
+import { receipt, tableOrEmptyNote, warning } from '../lib/ui.js';
+function targetOf(value) {
+    return value.startsWith('@')
+        ? { kind: 'domain', domain: value.slice(1) }
+        : { kind: 'email', email: value };
+}
+function labelOf(entry) {
+    return entry.kind === 'email' ? entry.email : `@${entry.domain}`;
+}
+function accessSentence(mode, name) {
+    return mode === 'open'
+        ? `Anyone with the link can open ${name}, without signing in.`
+        : `Only the team and the people and companies on its list can open ${name}.`;
+}
+function addedReceipt(added, name) {
+    if (added.entry.kind === 'domain')
+        return receipt(`Added @${added.entry.domain} to ${name}`);
+    return added.told === true
+        ? receipt(`Added ${added.entry.email} to ${name} and emailed the link`)
+        : warning(`Added ${added.entry.email} to ${name}, but the email did not send.`);
+}
+async function setGeneralAccess(mode, format) {
+    const api = await signedInClient();
+    const project = await resolveProject(api);
+    const access = await dataOrThrow(api.PUT('/api/projects/{id}/general-access', {
+        params: { path: { id: project.id } },
+        body: { mode },
+    }));
+    printResult(format, access, () => `${receipt(`Set access of ${project.name} to ${access.mode}`)}\n${accessSentence(access.mode, project.name)}`);
+}
+async function addAccess(targets, format) {
+    const api = await signedInClient();
+    const project = await resolveProject(api);
+    const results = [];
+    for (const target of targets) {
+        results.push(await dataOrThrow(api.POST('/api/projects/{id}/access', {
+            params: { path: { id: project.id } },
+            body: targetOf(target),
+        })));
+    }
+    printResult(format, results, () => results.map((added) => addedReceipt(added, project.name)).join('\n'));
+}
+async function listAccess(format) {
+    const api = await signedInClient();
+    const project = await resolveProject(api);
+    const rows = await dataOrThrow(api.GET('/api/projects/{id}/access', { params: { path: { id: project.id } } }));
+    printResult(format, rows, () => [
+        accessSentence(project.generalAccess.mode, project.name),
+        '',
+        tableOrEmptyNote(['PERSON OR COMPANY', 'STATUS'], rows.map((row) => [
+            labelOf(row),
+            row.kind === 'domain'
+                ? 'anyone at this company'
+                : row.firstOpenedAt === null
+                    ? 'not opened yet'
+                    : 'opened it',
+        ]), `Nobody is named on ${project.name} yet.`),
+    ].join('\n'));
+}
+async function removeAccess(target, format) {
+    const api = await signedInClient();
+    const project = await resolveProject(api);
+    const rows = await dataOrThrow(api.GET('/api/projects/{id}/access', { params: { path: { id: project.id } } }));
+    const wanted = target.toLowerCase();
+    const row = rows.find((candidate) => labelOf(candidate) === wanted);
+    if (row === undefined) {
+        throw new CliError('not_shared', `${target} is not on the list for ${project.name}.`);
+    }
+    await dataOrThrow(api.DELETE('/api/projects/{id}/access/{accessId}', {
+        params: { path: { id: project.id, accessId: row.id } },
+    }));
+    printResult(format, { status: 'ok', removed: labelOf(row) }, () => receipt(`Removed ${labelOf(row)} from ${project.name}`));
+}
+export const accessCommand = new Command('access').description('control who can open a project');
+accessCommand
+    .command('list', { isDefault: true })
+    .description('show who can open a project')
+    .action(commandAction((format) => listAccess(format)));
+accessCommand
+    .command('add')
+    .argument('<targets...>', 'email addresses, or @company.com for everyone at a company')
+    .description('let named people or a whole company open a project')
+    .action(commandAction((format, _command, targets) => addAccess(targets, format)));
+accessCommand
+    .command('remove')
+    .argument('<target>', 'an email address, or @company.com')
+    .description('take someone or a company off a project')
+    .action(commandAction((format, _command, target) => removeAccess(target, format)));
+accessCommand
+    .command('set')
+    .addOption(new Option('--mode <mode>', 'restricted lets in the people and companies on the list, open lets in anyone with the link')
+    .choices(['restricted', 'open'])
+    .makeOptionMandatory())
+    .description('choose whether the list decides who can open a project')
+    .action(commandAction((format, command) => setGeneralAccess(command.opts().mode, format)));

package/dist/commands/deploy/archive.js

@@ -0,0 +1,67 @@
+/* What git ignores stays home, matched by git's own rules in every folder's .gitignore, and a .env never goes in
+   the archive, because a value landing in an image layer would sit there for as long as the image exists. */
+import { readFileSync } from 'node:fs';
+import { join } from 'node:path';
+import ignore, {} from 'ignore';
+import { create } from 'tar';
+const ALWAYS_SKIPPED = [
+    'node_modules',
+    '.git',
+    'dist',
+    'build',
+    'out',
+    'target',
+    'vendor',
+    '.venv',
+    '.next',
+    '.turbo',
+    'coverage',
+];
+const ENV_FILE_PATTERN = /(^|\/)\.env(\..+)?$/;
+function readOrEmpty(path) {
+    try {
+        return readFileSync(path, 'utf8');
+    }
+    catch {
+        return '';
+    }
+}
+function ignoredBy(root) {
+    const rootRules = ignore()
+        .add(ALWAYS_SKIPPED)
+        .add(readOrEmpty(join(root, '.gitignore')))
+        .add(readOrEmpty(join(root, '.dockerignore')));
+    const nested = new Map();
+    function rulesIn(folder) {
+        if (!nested.has(folder)) {
+            const raw = readOrEmpty(join(root, folder, '.gitignore'));
+            nested.set(folder, raw === '' ? null : ignore().add(raw));
+        }
+        return nested.get(folder) ?? null;
+    }
+    return (path, isDirectory) => {
+        const asked = isDirectory ? `${path}/` : path;
+        if (ENV_FILE_PATTERN.test(path) || rootRules.ignores(asked))
+            return true;
+        const folders = path.split('/').slice(0, -1);
+        return folders.some((_, index) => {
+            const folder = folders.slice(0, index + 1).join('/');
+            return rulesIn(folder)?.ignores(asked.slice(folder.length + 1)) === true;
+        });
+    };
+}
+export async function archiveOf(root) {
+    const ignored = ignoredBy(root);
+    const chunks = [];
+    const stream = create({
+        cwd: root,
+        gzip: true,
+        filter: (path, entry) => {
+            const relative = path.replace(/^\.\/?/, '');
+            return relative === '' || !ignored(relative, 'isDirectory' in entry && entry.isDirectory());
+        },
+    }, ['.']);
+    for await (const chunk of stream)
+        chunks.push(Buffer.from(chunk));
+    return Buffer.concat(chunks);
+}

package/dist/commands/deploy/deploy-flags.js

@@ -0,0 +1,54 @@
+import { CliError } from '../../lib/errors.js';
+const EXAMPLE_VALUE = {
+    '--path': '/api',
+    '--dockerfile': 'docker/Dockerfile',
+    '--volume': '/app/data',
+};
+function servicePairs(values, flag, onlyServices) {
+    return values.map((value) => {
+        const separatorIndex = value.indexOf('=');
+        if (separatorIndex < 1) {
+            throw new CliError('bad_flag', `Write ${flag} as a service and a value, like ${flag} backend=${EXAMPLE_VALUE[flag]}.`, flag);
+        }
+        const name = value.slice(0, separatorIndex);
+        if (onlyServices.length > 0 && !onlyServices.includes(name)) {
+            throw new CliError('bad_flag', `${flag} ${value} is for ${name}, which --service leaves out. Add --service ${name}.`, '--service');
+        }
+        return [name, value.slice(separatorIndex + 1)];
+    });
+}
+export function parseDeployFlags(flags) {
+    const volumes = new Map();
+    for (const [name, path] of servicePairs(flags.volumes, '--volume', flags.services)) {
+        volumes.set(name, [...(volumes.get(name) ?? []), path]);
+    }
+    return {
+        onlyServices: flags.services,
+        paths: new Map(servicePairs(flags.paths, '--path', flags.services)),
+        dockerfiles: new Map(servicePairs(flags.dockerfiles, '--dockerfile', flags.services)),
+        volumes,
+    };
+}
+export function servicesToSend(found, serviceFlags) {
+    const deploying = serviceFlags.onlyServices.length > 0
+        ? serviceFlags.onlyServices
+        : [
+            ...new Set([
+                ...found,
+                ...serviceFlags.paths.keys(),
+                ...serviceFlags.dockerfiles.keys(),
+                ...serviceFlags.volumes.keys(),
+            ]),
+        ];
+    return deploying.map((name) => {
+        const pathPrefix = serviceFlags.paths.get(name);
+        const dockerfile = serviceFlags.dockerfiles.get(name);
+        const volumes = serviceFlags.volumes.get(name);
+        return {
+            name,
+            ...(pathPrefix === undefined ? {} : { pathPrefix }),
+            ...(dockerfile === undefined ? {} : { dockerfile }),
+            ...(volumes === undefined ? {} : { volumes }),
+        };
+    });
+}