Skip to content

docs: update #8

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Dec 13, 2024
Merged

docs: update #8

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1938506
docs: update
Kikobeats Dec 13, 2024
8507993
Update README.md
Kikobeats Dec 13, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 23 additions & 13 deletions README.md
View file
Open in desktop
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
View file
Open in desktop

This file was deleted.

Binary file added demo.mp4
View file
Open in desktop
Binary file not shown.
1 change: 0 additions & 1 deletion package.json
View file
Open in desktop
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
Loading