From f584bd0562903e40c54aa783011309eb4332488a Mon Sep 17 00:00:00 2001 From: SF-CLI-BOT Date: Fri, 4 Jun 2021 16:37:06 +0000 Subject: [PATCH] chore(release): 0.0.3 [ci skip] --- CHANGELOG.md | 7 +++++++ README.md | 49 ++++++++++++++++++++++++++++++++++++++++++++++++- package.json | 2 +- 3 files changed, 56 insertions(+), 2 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index dac43a37..912a9a56 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,13 @@ All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines. +### [0.0.3](https://github.com/salesforcecli/plugin-env/compare/v0.0.2...v0.0.3) (2021-06-04) + + +### Features + +* env open @W-9104301@ ([#31](https://github.com/salesforcecli/plugin-env/issues/31)) ([3a79a41](https://github.com/salesforcecli/plugin-env/commit/3a79a41c64cb60bbb79e542a78b1297e23924580)) + ### [0.0.2](https://github.com/salesforcecli/plugin-env/compare/v0.0.1...v0.0.2) (2021-05-24) diff --git a/README.md b/README.md index 61def52c..d7526e18 100644 --- a/README.md +++ b/README.md @@ -64,6 +64,7 @@ sfdx plugins * [`sf env:list`](#sf-envlist) +* [`sf env:open`](#sf-envopen) ## `sf env:list` @@ -89,5 +90,51 @@ EXAMPLES sf env list --all ``` -_See code: [src/commands/env/list.ts](https://github.com/salesforcecli/plugin-env/blob/v0.0.1/src/commands/env/list.ts)_ +_See code: [src/commands/env/list.ts](https://github.com/salesforcecli/plugin-env/blob/v0.0.2/src/commands/env/list.ts)_ + +## `sf env:open` + +You can open the following types of environments in a web browser: scratch orgs, sandboxes, Dev Hubs, and production orgs. + +``` +USAGE + $ sf env:open + +OPTIONS + -e, --target-env=target-env Environment name or alias to open. + -p, --path=path Path to append to the end of the login URL. + -r, --url-only Display the URL, but don’t launch it in a browser. + --browser=browser Browser in which to open the environment. + +DESCRIPTION + If you run the command without flags, it attempts to open your default environment in your default web browser. + + Each of your environments is associated with an instance URL, such as https://login.salesforce.com. To open a specific + web page at that URL, specify the portion of the URL after "/" with the --path flag, such as /apex/YourPage to + open a Visualforce page. + You can open the following types of environments in a web browser: scratch orgs, sandboxes, Dev Hubs, and production + orgs. + + If you run the command without flags, it attempts to open your default environment in your default web browser. + + Each of your environments is associated with an instance URL, such as https://login.salesforce.com. To open a specific + web page at that URL, specify the portion of the URL after "/" with the --path flag, such as /apex/YourPage to + open a Visualforce page. + +EXAMPLES + To open your default environment, run the command without flags: + sf env open + This example opens the Visualforce page /apex/StartHere in a scratch org + with alias "test-org": + sf env open --target-env test-org --path /apex/StartHere + If you want to view the URL for the preceding command, but not launch it in a browser, + add the --url-only flag: + sf env open --target-env test-org --path /apex/StartHere --url-only + The preceding examples open the environment in your default web browser. To use + a different browser, set the --browser flag to its OS-specific name. For example, + to use Chrome on macOS: + sf env open --target-env test-org --path /apex/StartHere --browser "google chrome" +``` + +_See code: [src/commands/env/open.ts](https://github.com/salesforcecli/plugin-env/blob/v0.0.2/src/commands/env/open.ts)_ diff --git a/package.json b/package.json index 779a6653..4e5470b2 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "name": "@salesforce/plugin-env", "description": "An sf plugin for logging into and interacting with different Salesforce environments.", - "version": "0.0.2", + "version": "0.0.3", "author": "Salesforce", "bugs": "https://github.com/forcedotcom/cli/issues", "dependencies": {