Skip to content

Commit c7c1280

Browse files
Update README.md
1 parent 6fe0b52 commit c7c1280

File tree

1 file changed

+100
-2
lines changed

1 file changed

+100
-2
lines changed

README.md

Lines changed: 100 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,101 @@
1-
# CodeEditCLI
1+
<p align="center">
2+
<img src="https://user-images.githubusercontent.com/806104/205848006-f2654778-21f1-4f97-b292-32849cc1eff6.png" height="128">
3+
<h1 align="center">CodeEdit CLI</h1>
4+
</p>
25

3-
A description of this package.
6+
<p align="center">
7+
<a aria-label="Follow CodeEdit on Twitter" href="https://twitter.com/CodeEditApp" target="_blank">
8+
<img alt="" src="https://img.shields.io/badge/Follow%[email protected]?style=for-the-badge&logo=Twitter">
9+
</a>
10+
<a aria-label="Join the community on Discord" href="https://discord.gg/vChUXVf9Em" target="_blank">
11+
<img alt="" src="https://img.shields.io/badge/Join%20the%20community-black.svg?style=for-the-badge&logo=Discord">
12+
</a>
13+
</p>
14+
15+
`codeedit` a set of command line tools that ship with CodeEdit which allow users to open and interact with editor via the command line.
16+
17+
## Documentation
18+
19+
### `open`
20+
21+
Opens CodeEdit.
22+
23+
## Folder
24+
25+
```sh
26+
codeedit ./my-project
27+
```
28+
29+
## File
30+
31+
```sh
32+
codeedit index.html
33+
```
34+
35+
From an optional line
36+
37+
```sh
38+
codeedit index.html:50
39+
```
40+
41+
From an optional line and column
42+
43+
```sh
44+
codeedit index.html:50:15
45+
```
46+
47+
### `--version`
48+
49+
Outputs the version of CodeEdit and CodeEdit CLI Tools.
50+
51+
```sh
52+
codeedit --version
53+
```
54+
55+
or
56+
57+
```sh
58+
codeedit -v
59+
```
60+
61+
### `new-window`
62+
63+
Opens a new window.
64+
65+
```sh
66+
codeedit new-window
67+
```
68+
69+
### `--goto`
70+
71+
Opens a file at a line and optional position.
72+
73+
Documentation coming soon.
74+
75+
### `list-extensions`
76+
77+
Documentation coming soon.
78+
79+
### `install`
80+
81+
Install an extension.
82+
83+
Documentation coming soon.
84+
85+
### `uninstall`
86+
87+
Uninstall an extension.
88+
89+
Documentation coming soon.
90+
91+
### `activate`
92+
93+
Activate an extension.
94+
95+
Documentation coming soon.
96+
97+
### `deactivate`
98+
99+
Deactivate an extension.
100+
101+
Documentation coming soon.

0 commit comments

Comments
 (0)