diff --git a/packages/types/src/project-config.ts b/packages/types/src/project-config.ts index 548d96ff69c..6b2b7363a91 100644 --- a/packages/types/src/project-config.ts +++ b/packages/types/src/project-config.ts @@ -2,8 +2,8 @@ /* eslint-disable */ -import type { PartialTaskConfig, PlatformType, TaskConfig } from './tasks-config'; import type { UnresolvedVersionSpec } from './toolchain-config'; +import type { PartialTaskConfig, PlatformType, TaskConfig } from './tasks-config'; /** The task-to-task relationship of the dependency. */ export type DependencyType = 'cleanup' | 'required' | 'optional'; diff --git a/packages/types/src/toolchain-config.ts b/packages/types/src/toolchain-config.ts index 2589a8f1443..1762e3021f1 100644 --- a/packages/types/src/toolchain-config.ts +++ b/packages/types/src/toolchain-config.ts @@ -272,10 +272,8 @@ export interface PythonConfig { /** * Assumes only the root `requirements.txt` is used for dependencies. * Can be used to support the "one version policy" pattern. - * - * @default true */ - rootRequirementsOnly?: boolean; + rootRequirementsOnly: boolean; /** * Defines the virtual environment name, which will be created in the workspace root. * Project dependencies will be installed into this. @@ -665,8 +663,6 @@ export interface PartialPythonConfig { /** * Assumes only the root `requirements.txt` is used for dependencies. * Can be used to support the "one version policy" pattern. - * - * @default true */ rootRequirementsOnly?: boolean | null; /** diff --git a/website/blog/2024-12-25_proto-v0.44.mdx b/website/blog/2024-12-25_proto-v0.44.mdx new file mode 100644 index 00000000000..1eb62c38bb3 --- /dev/null +++ b/website/blog/2024-12-25_proto-v0.44.mdx @@ -0,0 +1,96 @@ +--- +slug: proto-v0.44 +title: proto v0.44 - New terminal user interface and versions command +authors: [milesj] +tags: [terminal, console, ui, user, interface] +# image: ./img/proto/v0.44.png +--- + +import Image from '@site/src/components/Image'; + +Merry Christmas and happy holidays 🎄! In this release, we're introducing a new terminal user +interface. + + + +## New terminal output + +We're excited to introduce new terminal outputs, also known as a terminal user interface (TUI), for +all commands! We stumbled upon the [iocraft](https://docs.rs/iocraft/latest/iocraft/) Rust crate, +which is a library for rendering terminal output using components and JSX-like syntax. As fans of +[React](https://react.dev/) and [Ink](https://github.com/vadimdemedes/ink), this felt like the +perfect opportunity to revisit all of our commands and implement a new interface unique to proto +(and moon in the future). + +Here are some examples of this new output. A lot of it is still a work in progress and will be +tweaked going forward, but we're already impressed with what iocraft can achieve! + +### Notices + + + + +### Information + + + + +### Tables + + + + +### Prompts + + + + +### Progress + + + +## New `proto versions` command + +After much feedback, we've decided to merge the `proto list` and `proto list-remote` commands into a +new command, [`proto versions`](/docs/proto/commands/versions). This command will list all versions +available for the provided tool, while also annotating which of those versions has been installed +locally. + +This data can now be accessed as JSON by passing the `--json` flag. + +```shel +$ proto versions node +... +22.0.0 +22.1.0 +22.2.0 +22.3.0 +22.4.0 +22.4.1 +22.5.0 +22.5.1 +22.6.0 +22.7.0 +22.8.0 +22.9.0 +22.10.0 +22.11.0 +22.12.0 +23.0.0 +23.1.0 +23.2.0 +23.3.0 +23.4.0 - installed 12/19/24 +23.5.0 - installed 12/25/24 +``` + +## Other changes + +View the [official release](https://github.com/moonrepo/proto/releases/tag/v0.42.0) for a full list +of changes. + +- Added a `--yes` option to `proto outdated`, that skips confirmation prompts. +- Added a `--json` option to `proto clean`, to capture the cleaned result as JSON. +- Updated `proto clean` to accept a target in which to clean as the 1st argument. For example, + `proto clean cache`. +- Moved the `--json` and `--yes` options into global options. diff --git a/website/blog/img/proto/v0.44/confirm.png b/website/blog/img/proto/v0.44/confirm.png new file mode 100644 index 00000000000..3c705cb0af2 Binary files /dev/null and b/website/blog/img/proto/v0.44/confirm.png differ diff --git a/website/blog/img/proto/v0.44/info-env.png b/website/blog/img/proto/v0.44/info-env.png new file mode 100644 index 00000000000..e658c66dc44 Binary files /dev/null and b/website/blog/img/proto/v0.44/info-env.png differ diff --git a/website/blog/img/proto/v0.44/info-plugin.png b/website/blog/img/proto/v0.44/info-plugin.png new file mode 100644 index 00000000000..b8f3425539d Binary files /dev/null and b/website/blog/img/proto/v0.44/info-plugin.png differ diff --git a/website/blog/img/proto/v0.44/notice-caution.png b/website/blog/img/proto/v0.44/notice-caution.png new file mode 100644 index 00000000000..6213ea30c02 Binary files /dev/null and b/website/blog/img/proto/v0.44/notice-caution.png differ diff --git a/website/blog/img/proto/v0.44/notice-success.png b/website/blog/img/proto/v0.44/notice-success.png new file mode 100644 index 00000000000..64c8f45c016 Binary files /dev/null and b/website/blog/img/proto/v0.44/notice-success.png differ diff --git a/website/blog/img/proto/v0.44/progress.png b/website/blog/img/proto/v0.44/progress.png new file mode 100644 index 00000000000..7bc75b80dbc Binary files /dev/null and b/website/blog/img/proto/v0.44/progress.png differ diff --git a/website/blog/img/proto/v0.44/select.png b/website/blog/img/proto/v0.44/select.png new file mode 100644 index 00000000000..4c69e1ae1d7 Binary files /dev/null and b/website/blog/img/proto/v0.44/select.png differ diff --git a/website/blog/img/proto/v0.44/table-outdated.png b/website/blog/img/proto/v0.44/table-outdated.png new file mode 100644 index 00000000000..b5ad867e0fd Binary files /dev/null and b/website/blog/img/proto/v0.44/table-outdated.png differ diff --git a/website/blog/img/proto/v0.44/table-search.png b/website/blog/img/proto/v0.44/table-search.png new file mode 100644 index 00000000000..8a99d3f80a1 Binary files /dev/null and b/website/blog/img/proto/v0.44/table-search.png differ diff --git a/website/docs/proto/commands/activate.mdx b/website/docs/proto/commands/activate.mdx index 3805c1571cf..d9622715774 100644 --- a/website/docs/proto/commands/activate.mdx +++ b/website/docs/proto/commands/activate.mdx @@ -105,7 +105,7 @@ proto activate murex -> source Generate the hook: ```shell -proto activate nu > ~/.config/nushell/proto-hook.nu +(proto activate nu) | save ~/.config/nushell/proto-hook.nu ``` Then add the following line to your `~/.config/nushell/config.nu` file. diff --git a/website/docs/proto/commands/alias.mdx b/website/docs/proto/commands/alias.mdx index 7caad8df84c..295522f457a 100644 --- a/website/docs/proto/commands/alias.mdx +++ b/website/docs/proto/commands/alias.mdx @@ -23,7 +23,5 @@ the location. ## Options -- `--global` (deprecated) - Pin to the global `~/.proto/.prototools` instead of the local - `./.prototools`. - `--to` - [Location of `.prototools`](../config#locations) to update. diff --git a/website/docs/proto/commands/clean.mdx b/website/docs/proto/commands/clean.mdx index ca4d85f2598..4b519b885d4 100644 --- a/website/docs/proto/commands/clean.mdx +++ b/website/docs/proto/commands/clean.mdx @@ -2,27 +2,28 @@ title: clean --- -The `proto clean` command can be used to uninstall stale and unused tools or plugins. By default, it -will remove items that haven't been used in the last 30 days. +import VersionLabel from '@site/src/components/Docs/VersionLabel'; + +The `proto clean` command can be used to uninstall stale and unused tools, plugins, and more. By +default, it will remove items that haven't been used in the last 30 days. ```shell $ proto clean ``` -Furthermore, the command can be used to purge a tool, which will remove it entirely from proto, or -purge all downloaded plugins. +Furthermore, the command can be used to target a specific artifact type. ```shell -# Delete node from proto -$ proto clean --purge node - -# Delete all plugins -$ proto clean --purge-plugins +$ proto clean plugins ``` +### Arguments + +- `[target]` - Type of target. Accepts `cache`, `plugins`, `temp`, or `tools`. + + ### Options - `--days` - Number of days before a tool is considered stale. -- `--purge` - Purge and delete the installed tool by ID (`~/.proto/tools/`). -- `--purge-plugins` - Purge and delete all downloaded plugins (`~/.proto/plugins`). +- `--json` - Print the clean result in JSON format. - `--yes` - Avoid and confirm all prompts. diff --git a/website/docs/proto/commands/debug/config.mdx b/website/docs/proto/commands/debug/config.mdx index 9871193e3f4..d7b48f748f9 100644 --- a/website/docs/proto/commands/debug/config.mdx +++ b/website/docs/proto/commands/debug/config.mdx @@ -14,7 +14,8 @@ end. ``` $ proto debug config -~/.proto/.prototools +/Users/name/.proto/.prototools ─────────────────────────────────────────── + node = "20.0.0" npm = "bundled" @@ -24,7 +25,8 @@ $ proto debug config [settings] auto-clean = false -Configuration +Final configuration ─────────────────────────────────────────────────────── + node = "20.0.0" npm = "bundled" diff --git a/website/docs/proto/commands/debug/env.mdx b/website/docs/proto/commands/debug/env.mdx index 77d231842ae..d8a390ad44d 100644 --- a/website/docs/proto/commands/debug/env.mdx +++ b/website/docs/proto/commands/debug/env.mdx @@ -13,28 +13,32 @@ the store location, relevant file paths, and environment variables. ``` $ proto debug env -Store - Root: ~/.proto - Bins: ~/.proto/bin - Shims: ~/.proto/shims - Plugins: ~/.proto/plugins - Tools: ~/.proto/tools - Temp: ~/.proto/temp - Virtual: - /userhome - ~ - /proto - ~/.proto - /workspace - ~/Projects/example - Configs: - - ~/Projects/example/.prototools - - ~/.proto/.prototools - -Environment - Proto version: 0.26.0 +Store ───────────────────────────────────────────────────────────────────── + + Root: /Users/name/.proto + Bins: /Users/name/.proto/bin + Shims: /Users/name/.proto/shims + Plugins: /Users/name/.proto/plugins + Tools: /Users/name/.proto/tools + Temp: /Users/name/.proto/temp + +Environment ─────────────────────────────────────────────────────────────── + + Proto version: 0.44.0 Operating system: macos Architecture: arm64 - Variables: - PROTO_HOME - ~/.proto - PROTO_VERSION - 0.26.0 + Config sources: + - /Users/name/Projects/example/.prototools + - /Users/name/.proto/.prototools + Virtual paths: + /userhome = /Users/name + /proto = /Users/name/.proto + /cwd = /Users/name/Projects/example + Environment variables: + PROTO_APP_LOG = proto=info,schematic=info,starbase=info,warpgate=info,extism::pdk=info + PROTO_HOME = /Users/name/.proto + PROTO_OFFLINE_TIMEOUT = 750 + PROTO_VERSION = 0.44.0 ``` ### Options diff --git a/website/docs/proto/commands/diagnose.mdx b/website/docs/proto/commands/diagnose.mdx index 317f7a32a04..0919c2b8468 100644 --- a/website/docs/proto/commands/diagnose.mdx +++ b/website/docs/proto/commands/diagnose.mdx @@ -14,15 +14,13 @@ maybe fix (depending on your usage of proto). $ proto diagnose Shell: zsh -Shell profile: ~/.zshrc +Shell profile: /Users/name/.zshrc -Errors - Issue: Bin directory (~/.proto/bin) was found BEFORE the shims directory (~/.proto/shims) on PATH - Resolution: Ensure the shims path comes before the bin path in your shell +Errors ──────────────────────────────────────────────────────────────────── -Warnings - Issue: Missing PROTO_HOME environment variable (Will default to ~/.proto if not defined) - Resolution: Export PROTO_HOME="$HOME/.proto" from your shell + - Issue: Bin directory /Users/name/.proto/bin was found BEFORE the shims directory /Users/name/.proto/shims on PATH + Resolution: Ensure the shims path comes before the bin path in your shell + Comment: Runtime version detection will not work correctly unless shims are used ``` ### Options diff --git a/website/docs/proto/commands/list-remote.mdx b/website/docs/proto/commands/list-remote.mdx index 985545af6d0..7afbe293c2e 100644 --- a/website/docs/proto/commands/list-remote.mdx +++ b/website/docs/proto/commands/list-remote.mdx @@ -2,6 +2,12 @@ title: list-remote --- +:::danger + +This command was removed in v0.44, use [`proto versions`](./versions) instead! + +::: + The `proto list-remote ` (or `proto lsr`) command will list available versions by resolving versions from the tool's remote release manifest. diff --git a/website/docs/proto/commands/list.mdx b/website/docs/proto/commands/list.mdx index 61488a4321e..0c43e29cafa 100644 --- a/website/docs/proto/commands/list.mdx +++ b/website/docs/proto/commands/list.mdx @@ -2,6 +2,12 @@ title: list --- +:::danger + +This command was removed in v0.44, use [`proto versions`](./versions) instead! + +::: + The `proto list ` (or `proto ls`) command will list installed versions by scanning the manifest at `~/.proto/tools//manifest.json` for possible versions. diff --git a/website/docs/proto/commands/outdated.mdx b/website/docs/proto/commands/outdated.mdx index c42ba6284b0..13fe1e93efb 100644 --- a/website/docs/proto/commands/outdated.mdx +++ b/website/docs/proto/commands/outdated.mdx @@ -13,10 +13,15 @@ configuration file in which the version has been configured. ``` $ proto outdated -Tool Current Newest Latest Config -deno 1.40.0 1.42.4 1.42.4 ~/.prototools -node 20.8.0 20.12.2 21.7.3 ~/.prototools -npm 10.1.0 10.5.2 10.5.2 ~/.prototools +╭───────────────────────────────────────────────────────────────────────╮ +│ Tool Current Newest Latest Config │ +│───────────────────────────────────────────────────────────────────────│ +│ bun 1.1.42 1.1.42 1.1.42 /Users/name/.proto/.prototools │ +│ node 23.5.0 23.5.0 23.5.0 /Users/name/.proto/.prototools │ +│ npm 10.7.0 10.7.0 11.0.0 /Users/name/.proto/.prototools │ +│ rust 1.83.0 1.83.0 1.83.0 /Users/name/.proto/.prototools │ +│ yarn 3.6.3 3.8.7 4.5.1 /Users/name/.proto/.prototools │ +╰───────────────────────────────────────────────────────────────────────╯ ``` > By default, this command _does not_ check tools for versions pinned in the global @@ -27,3 +32,4 @@ npm 10.1.0 10.5.2 10.5.2 ~/.prototools - `--json` - Print the list in JSON format. - `--latest` - When updating versions with `--update`, use the latest version instead of newest. - `--update` - Update and write newest/latest versions to their respective configuration. +- `--yes` - Avoid and confirm all prompts. diff --git a/website/docs/proto/commands/pin.mdx b/website/docs/proto/commands/pin.mdx index 0c8e7abcf4b..f7421d047ee 100644 --- a/website/docs/proto/commands/pin.mdx +++ b/website/docs/proto/commands/pin.mdx @@ -23,8 +23,6 @@ the location. ### Options -- `--global` (deprecated) - Pin to the global `~/.proto/.prototools` instead of the local - `./.prototools`. - `--resolve` - Resolve the version to a fully-qualified semantic version before pinning. - `--to` - [Location of `.prototools`](../config#locations) to update. diff --git a/website/docs/proto/commands/plugin/add.mdx b/website/docs/proto/commands/plugin/add.mdx index 64196e60c4f..67d3d9f385e 100644 --- a/website/docs/proto/commands/plugin/add.mdx +++ b/website/docs/proto/commands/plugin/add.mdx @@ -23,7 +23,5 @@ $ proto plugin add node "https://github.com/moonrepo/node-plugin/releases/latest ### Options -- `--global` (deprecated) - Add to the global `~/.proto/.prototools` instead of the local - `./.prototools`. - `--to` - [Location of `.prototools`](../../config#locations) to update. diff --git a/website/docs/proto/commands/plugin/info.mdx b/website/docs/proto/commands/plugin/info.mdx index b5a6f980de3..7b4987ef3b6 100644 --- a/website/docs/proto/commands/plugin/info.mdx +++ b/website/docs/proto/commands/plugin/info.mdx @@ -12,33 +12,57 @@ The `proto plugin info ` command will display information about a tool and i ``` $ proto plugin info node -node - Node.js +Plugin ───────────────────────────────── -Plugin - Version: 0.10.0 - Source: https://github.com/moonrepo/node-plugin/releases/download/v0.10.0/node_plugin.wasm + ID: node + Name: Node.js + Type: Language + Version: 0.13.0 + Source URL: https://github.com/moonrepo/tools/releases/download/node_tool-v0.13.0/node_tool.wasm -Inventory - Store: ~/.proto/tools/node - Executable: ~/.proto/tools/node/20.0.0/bin/node - Global packages directory: ~/.proto/tools/node/globals/bin - Binaries: - - ~/.proto/bin/node (primary) +Inventory ────────────────────────────── + + Detected version: 23.5.0 + Fallback version: 23.5.0 + Store directory: /Users/name/.proto/tools/node + Executable file: /Users/name/.proto/tools/node/23.5.0/bin/node + Executables directory: /Users/name/.proto/tools/node/23.5.0/bin + Global packages directory: /Users/name/.proto/tools/node/globals/bin Shims: - - ~/.proto/shims/node (primary) + - /Users/name/.proto/shims/node + Binaries: + - /Users/name/.proto/bin/node + - /Users/name/.proto/bin/node-20 + - /Users/name/.proto/bin/node-20.15 + - /Users/name/.proto/bin/node-20.8 + - /Users/name/.proto/bin/node-23 + - /Users/name/.proto/bin/node-23.4 + - /Users/name/.proto/bin/node-23.5 Installed versions: - - 20.0.0 - Aliases: - argon - 4.9.1 - boron - 6.17.1 - carbon - 8.17.0 - dubnium - 10.24.1 - erbium - 12.22.12 - fermium - 14.21.3 - gallium - 16.20.2 - hydrogen - 18.19.1 - iron - 20.11.1 - latest - 21.6.2 + 20.8.0 - installed 12/19/24, last used 12/19/24 + 20.15.0 - installed 12/25/24, last used 12/25/24 + 23.4.0 - installed 12/19/24, last used 12/19/24 + 23.5.0 - installed 12/25/24, last used 12/25/24, fallback version + Remote aliases: + argon = 4.9.1 + boron = 6.17.1 + carbon = 8.17.0 + dubnium = 10.24.1 + erbium = 12.22.12 + fermium = 14.21.3 + gallium = 16.20.2 + hydrogen = 18.20.5 + iron = 20.18.1 + jod = 22.12.0 + latest = 23.5.0 + stable = 22.12.0 + +Configuration ────────────────────────── + + Local aliases: + example = 19.0.0 + Environment variables: — + Settings: — ``` ### Arguments diff --git a/website/docs/proto/commands/plugin/list.mdx b/website/docs/proto/commands/plugin/list.mdx index af4bbb5bade..d3c5b88a90e 100644 --- a/website/docs/proto/commands/plugin/list.mdx +++ b/website/docs/proto/commands/plugin/list.mdx @@ -17,36 +17,34 @@ available aliases, and store location. ``` $ proto plugin list --versions -bun - Bun - Store: ~/.proto/tools/bun - Source: https://github.com/moonrepo/bun-plugin/releases/download/v0.10.0/bun_plugin.wasm - Versions: - 1.0.13 - installed 11/21/23, last used 02/28/24, default version - 0.8.0 - installed 11/19/23, last used 03/04/24 - 1.0.0 - installed 11/19/23, last used 03/04/24 - 1.0.15 - installed 12/09/23, last used 03/04/24 - -deno - Deno - Store: ~/.proto/tools/deno - Source: https://github.com/moonrepo/deno-plugin/releases/download/v0.10.0/deno_plugin.wasm +Bun ──────────────────────────────────── + + ID: bun + Source URL: https://github.com/moonrepo/tools/releases/download/bun_tool-v0.14.0/bun_tool.wasm + Store directory: /Users/miles/.proto/tools/bun Versions: - 1.36.1 - installed 08/15/23, default version - 1.30.0 - installed 02/01/24, last used 03/04/24 - 1.38.0 - installed 11/08/23 - 1.40.0 - installed 02/01/24, last used 03/04/24 - -go - Go - Store: ~/.proto/tools/go - Source: https://github.com/moonrepo/go-plugin/releases/download/v0.10.0/go_plugin.wasm + 1.1.42 - installed 12/25/24, fallback version + +Deno ─────────────────────────────────── + + ID: deno + Source URL: https://github.com/moonrepo/tools/releases/download/deno_tool-v0.13.0/deno_tool.wasm + Store directory: /Users/miles/.proto/tools/deno Versions: - 1.21.5 - installed 12/06/23, last used 02/29/24, default version - 1.20.12 - installed 12/09/23 + 1.30.0 - installed 02/01/24, last used 11/28/24 + 1.40.0 - installed 02/01/24, last used 12/09/24 + 1.43.1 - installed 12/25/24, fallback version + +Go ───────────────────────────────────── -node - Node.js - Store: ~/.proto/tools/node - Source: https://github.com/moonrepo/node-plugin/releases/download/v0.10.0/node_plugin.wasm + ID: go + Source URL: https://github.com/moonrepo/tools/releases/download/go_tool-v0.14.0/go_tool.wasm + Store directory: /Users/miles/.proto/tools/go Versions: - 20.0.0 - installed 09/03/23, last used 03/04/24, default version + 1.18.0 - installed 12/25/24, fallback version + 1.19.0 - installed 12/22/24 + 1.20.12 - installed 12/09/23 + 1.23.4 - installed 12/24/24 ``` A list of tool IDs can be provided to filter the output list. diff --git a/website/docs/proto/commands/plugin/remove.mdx b/website/docs/proto/commands/plugin/remove.mdx index 23c5c39f92b..10d4feca276 100644 --- a/website/docs/proto/commands/plugin/remove.mdx +++ b/website/docs/proto/commands/plugin/remove.mdx @@ -24,5 +24,3 @@ $ proto plugin remove node - `--from` - [Location of `.prototools`](../../config#locations) to update. -- `--global` (deprecated) - Remove from the global `~/.proto/.prototools` instead of the local - `./.prototools`. diff --git a/website/docs/proto/commands/plugin/search.mdx b/website/docs/proto/commands/plugin/search.mdx index 100b859490d..13c5a19d96c 100644 --- a/website/docs/proto/commands/plugin/search.mdx +++ b/website/docs/proto/commands/plugin/search.mdx @@ -13,11 +13,16 @@ on the provided query string. Built-in plugins _are not_ searchable. ``` $ proto plugin search moon -Plugins -Available for query: moon - - Plugin Author Format Description Locator - moon moonrepo TOML moon is a multi-language build system and codebase management tool. https://raw.githubusercontent.com/moonrepo/moon/master/proto-plugin.toml +Search results for: moon +Learn more about plugins: https://moonrepo.dev/docs/proto/plugins +╭──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮ +│ Plugin Author Format Description Locator │ +│──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────│ +│ moon moonrepo TOML moon is a multi- https://raw.githubusercontent.com/moonrepo/moon/master/proto- │ +│ language build system plugin.toml │ +│ and codebase management │ +│ tool. │ +╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ ``` ### Arguments diff --git a/website/docs/proto/commands/status.mdx b/website/docs/proto/commands/status.mdx index b195faf558d..f28a9b16a7e 100644 --- a/website/docs/proto/commands/status.mdx +++ b/website/docs/proto/commands/status.mdx @@ -11,11 +11,23 @@ what versions of those tools are resolved to, and the configuration file in whic ``` $ proto status +╭───────────────────────────────────────────────────────────────────────────────────────────────────────╮ +│ Tool Configured Resolved Installed Config │ +│───────────────────────────────────────────────────────────────────────────────────────────────────────│ +│ bun 1.1.42 1.1.42 /Users/name/.proto/tools/ /Users/name/.proto/.prototools │ +│ bun/1.1.42 │ +│ deno 1.43.1 1.43.1 /Users/name/.proto/tools/ /Users/name/.proto/.prototools │ +│ deno/1.43.1 │ +│ node 23.5.0 23.5.0 /Users/name/.proto/tools/ /Users/name/.proto/.prototools │ +│ node/23.5.0 │ +│ npm ~10.7 10.7.0 /Users/name/.proto/tools/ /Users/name/.proto/.prototools │ +│ npm/10.7.0 │ +│ python 3.12.0 3.12.0 /Users/name/.proto/tools/ /Users/name/.proto/.prototools │ +│ python/3.12.0 │ +│ yarn 3.6.3 3.6.3 /Users/name/.proto/tools/ /Users/name/.proto/.prototools │ +│ yarn/3.6.3 │ +╰───────────────────────────────────────────────────────────────────────────────────────────────────────╯ -Tool Configured Resolved Installed Config -deno 1.40.0 1.40.0 ~/.proto/tools/deno/1.40.0 ~/.prototools -node 20.8.0 20.8.0 ~/.proto/tools/node/20.8.0 ~/.prototools -npm 10.1.0 10.1.0 ~/.proto/tools/npm/10.1.0 ~/.prototools ``` > By default, this command _does not_ check tools for versions pinned in the global diff --git a/website/docs/proto/commands/unalias.mdx b/website/docs/proto/commands/unalias.mdx index bec9d70936c..23079449068 100644 --- a/website/docs/proto/commands/unalias.mdx +++ b/website/docs/proto/commands/unalias.mdx @@ -23,5 +23,3 @@ the location. - `--from` - [Location of `.prototools`](../config#locations) to update. -- `--global` (deprecated) - Remove from the global `~/.proto/.prototools` instead of the local - `./.prototools`. diff --git a/website/docs/proto/commands/unpin.mdx b/website/docs/proto/commands/unpin.mdx index ce9d6992ffa..16d06f7ce7d 100644 --- a/website/docs/proto/commands/unpin.mdx +++ b/website/docs/proto/commands/unpin.mdx @@ -23,5 +23,3 @@ the location. - `--from` - [Location of `.prototools`](../config#locations) to update. -- `--global` (deprecated) - Unpin from the global `~/.proto/.prototools` instead of the local - `./.prototools`. diff --git a/website/docs/proto/commands/use.mdx b/website/docs/proto/commands/use.mdx index 0ddf0e5aba6..65b5354d2bb 100644 --- a/website/docs/proto/commands/use.mdx +++ b/website/docs/proto/commands/use.mdx @@ -2,7 +2,7 @@ title: use --- -:::caution +:::danger This command has been deprecated and its functionality was merged into [`proto install`](./install) in v0.39. Use that command instead! diff --git a/website/docs/proto/commands/versions.mdx b/website/docs/proto/commands/versions.mdx new file mode 100644 index 00000000000..d4e4a7d514d --- /dev/null +++ b/website/docs/proto/commands/versions.mdx @@ -0,0 +1,47 @@ +--- +title: versions +--- + +import VersionLabel from '@site/src/components/Docs/VersionLabel'; + + + +The `proto versions ` command will list available versions by resolving versions from the +tool's remote release manifest. Furthermore, if a version has been installed locally, it will be +denoted with a timestamp. + +```shell +$ proto versions node +... +22.0.0 +22.1.0 +22.2.0 +22.3.0 +22.4.0 +22.4.1 +22.5.0 - installed 12/25/24 +22.5.1 +22.6.0 +22.7.0 +22.8.0 +22.9.0 +22.10.0 +22.11.0 +22.12.0 +23.0.0 +23.1.0 +23.2.0 +23.3.0 +23.4.0 - installed 12/19/24 +23.5.0 - installed 12/25/24 +``` + +### Arguments + +- `` - Type of tool. + +### Options + +- `--aliases` - Include aliases in the list. +- `--installed` - Only display installed versions. +- `--json` - Print the versions and aliases in JSON format. diff --git a/website/sidebars.ts b/website/sidebars.ts index 6c28374d6f9..d7486c7e8f4 100644 --- a/website/sidebars.ts +++ b/website/sidebars.ts @@ -313,8 +313,6 @@ const sidebars: SidebarsConfig = { }, 'proto/commands/diagnose', 'proto/commands/install', - 'proto/commands/list', - 'proto/commands/list-remote', 'proto/commands/outdated', 'proto/commands/pin', { @@ -343,7 +341,7 @@ const sidebars: SidebarsConfig = { 'proto/commands/uninstall', 'proto/commands/unpin', 'proto/commands/upgrade', - 'proto/commands/use', + 'proto/commands/versions', ], }, 'proto/faq', diff --git a/website/static/schemas/toolchain.json b/website/static/schemas/toolchain.json index 291befc0706..b4cc88b5fa4 100644 --- a/website/static/schemas/toolchain.json +++ b/website/static/schemas/toolchain.json @@ -677,7 +677,6 @@ "rootRequirementsOnly": { "title": "rootRequirementsOnly", "description": "Assumes only the root requirements.txt is used for dependencies. Can be used to support the \"one version policy\" pattern.", - "default": true, "type": "boolean", "markdownDescription": "Assumes only the root `requirements.txt` is used for dependencies. Can be used to support the \"one version policy\" pattern." },