usecloudy 0.0.0-stage → 0.3.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 The Cloudtifact authors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,3 +1,98 @@
-# Temporary Holding Version
+# Cloudy 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 command line for [Cloudy](https://cloudtifact.com): publish pages and docs folders as links
+people comment on, keep every version, and give the comments back to your coding agent.
+
+```sh
+npm i -g usecloudy
+```
+
+The command it installs is `cloudy`. `cloudtifact` still works as the same command, so older scripts and hooks keep
+running. The same CLI is also on npm under its old package name, `cloudtifact`, kept up to date for existing installs.
+Both packages install the same commands, so keep only one: to move, run `npm rm -g cloudtifact`, then
+`npm i -g usecloudy`.
+
+Or run it once without installing: `npx usecloudy publish page.html`.
+
+Without npm, use the install script:
+
+```sh
+curl -fsSL https://api.cloudtifact.com/install.sh | sh
+```
+
+The script puts the CLI in `~/.cloudtifact` (commands `cloudy` and `cloudtifact`) and adds `~/.cloudtifact/bin` to your PATH. Open a new terminal afterwards.
+
+```sh
+cloudy login
+cloudy publish page.html      # one page or folder → a link
+cloudy copy https://cloudtifact.app/<id>/   # your own copy of a page someone sent
+cloudy context pull --space <id>            # Discord thread linked to the space
+cloudy init && cloudy push   # a repo's docs folder, versioned
+cloudy comments --toon        # what reviewers said, compact for agents
+```
+
+Requires Node.js 20 or later. The CLI is one file with no dependencies.
+
+## Update and remove
+
+```sh
+cloudy upgrade
+```
+
+Installed with npm: `npm i -g usecloudy@latest` to update, `npm rm -g usecloudy` to remove (`cloudtifact` in
+place of `usecloudy` if you installed the old package).
+
+Installed with the script: `upgrade` downloads the latest CLI and replaces `~/.cloudtifact/cloudtifact.mjs`.
+It prints the old and new version, or says the CLI is already up to date.
+
+Once a day the CLI checks in the background for a newer version, and after a command tells you on one line when there
+is one. It stays quiet with `--json` or `--toon`, when output goes to a file or another program, and in CI. To turn
+it off, set `CLOUDTIFACT_NO_UPDATE_NOTIFIER=1`.
+
+To remove a script install:
+
+```sh
+rm -rf ~/.cloudtifact               # the CLI
+rm -f ~/.local/bin/cloudy ~/.local/bin/cloudtifact   # the links, if the installer made them
+rm -rf ~/.config/cloudtifact        # the saved token (run `cloudy logout` first to revoke it)
+```
+
+If the installer added a PATH line to your shell's startup file (`~/.zshrc`, `~/.bashrc`, `~/.bash_profile`,
+`~/.profile` or `~/.config/fish/config.fish`), delete it too. It sits under a `# cloudtifact` comment and
+mentions `.cloudtifact/bin`.
+
+## More than one account
+
+```sh
+cloudy login                  # again, approving as your other account: adds it
+cloudy accounts               # * marks the active one
+cloudy switch                 # toggle between two (or: switch <handle>)
+cloudy push --account work    # one command as another account
+cloudy switch work --here     # this repo always uses @work, on this machine
+cloudy logout --account work  # sign out of one (or --all)
+```
+
+A folder set with `--here` never falls back to another account: if that account isn't signed in, the command stops.
+
+## For agents
+
+Add `--toon` (fewest tokens) or `--json` to commands that print data, or set `CLOUDTIFACT_FORMAT=toon`.
+`cloudy init --hooks` installs a skill and hooks for Claude Code, Codex and Cursor.
+
+## Configuration
+
+| Variable | Use |
+| --- | --- |
+| `CLOUDTIFACT_API_URL` | Point at another Cloudy server (self-hosted). The saved token is only sent to the server it came from, so run `cloudy login` with it set to sign in there |
+| `CLOUDTIFACT_FORMAT` | Default output: `text`, `toon` or `json` |
+| `CLOUDTIFACT_ACCOUNT` | Use this signed-in account (a handle), like `--account` |
+| `CLOUDTIFACT_TOKEN` | Use this token instead of any saved sign-in, for CI |
+| `CLOUDTIFACT_NO_UPDATE_NOTIFIER` | `1`: never say when a newer CLI is out |
+
+The tokens from `login` are stored in `~/.config/cloudtifact/config.json` (or `$XDG_CONFIG_HOME`).
+
+## Docs
+
+Every command and option: the [CLI reference](https://cloudtifact.com/docs/reference/cli).
+
+MIT licensed.