Skip to content

Commit

Permalink
Merge pull request #8 from vercel-labs/docs
Browse files Browse the repository at this point in the history
docs: update
  • Loading branch information
Kikobeats authored Dec 13, 2024
2 parents 2e3e8e1 + 8507993 commit 3294953
Show file tree
Hide file tree
Showing 4 changed files with 23 additions and 24 deletions.
36 changes: 23 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@
# vercel-open

The `vercel-open` custom command extension for the Vercel CLI
https://github.com/user-attachments/assets/c27b4e68-87d6-44b4-b113-0bbaf186879c

The `vc open` custom command extension for the Vercel CLI.

It makes easy to jump to vercel deployment URL from your terminal.

## Installation

Expand All @@ -10,28 +14,34 @@ npm install -g vercel-open

## Usage

**Automatic** - Requires that your working directory is a linked Vercel project:
Assuming your terminal is in a Vercel project folder:

**Resume information**

It show resume information about your project

```
vc open # open the vercel dahboard for the current project
vc open logs # open logs of the project
vc open logs --timeline=maximum # any query parameter is supported
vc open info
▲ overview https://vercel.com/vercel-labs/vercel-open/
▲ current (production) https://vercel.com/vercel-labs/vercel-open/9PEUQN2Z5BpAFxEsRtXoSkj8nhK9/
▲ latest (preview) https://vercel.com/vercel-labs/vercel-open/GSM3jnwUA8qEAUY42ZaXBVRV2QrJ/
```

**Custom** - Providing a `$team/$project` slug that will be opened:
**Opening in the browser**

It opens the URL in your browser

```
vc open vercel/v0 logs # will open `https://vercel.com/vercel/v0/logs` in the browser
vc open [current|latest] [--visit]
```

Also `vc open info` will print relevant information about your project:
**Jumping to a section**

```
> vc open info
It navigates to a project tab section.

▲ overview https://vercel.com/vercel-labs/vercel-open/
▲ current (production) https://vercel.com/vercel-labs/vercel-open/AtQTsruE87Lu6Nz3fhCrFyxV9t3T/
▲ latest (preview) https://vercel.com/vercel-labs/vercel-open/3AaqTjcDGqfEW6FjbywYKNaQfDW9/
```
vc open [current|latest] <logs|settings|etc> [--query-parameter]
```

## License
Expand Down
10 changes: 0 additions & 10 deletions bin/welcome.mjs

This file was deleted.

Binary file added demo.mp4
Binary file not shown.
1 change: 0 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,6 @@
"scripts": {
"build": "tsup --format esm bin/index.ts -d bin/",
"contributors": "(npx git-authors-cli && npx finepack && git add package.json && git commit -m 'build: contributors' --no-verify) || true",
"install": "node bin/welcome.mjs",
"postrelease": "npm run release:tags && npm run release:github && (ci-publish || npm publish --access=public)",
"prepublishOnly": "npm run build",
"release": "standard-version -a",
Expand Down

0 comments on commit 3294953

Please sign in to comment.