Skip to content

Commit 83c1e8f

Browse files
committed
Improved readme
1 parent 3d40cf1 commit 83c1e8f

File tree

1 file changed

+36
-0
lines changed

1 file changed

+36
-0
lines changed

README.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,42 @@ Options:
6060
--command Run the given command
6161
````
6262

63+
## Navigating and manipulating the repository
64+
65+
You can navigate the repository using familiar filesystem shell commands:
66+
67+
````bash
68+
PHPCRSH > ls
69+
+-----------------+------------+-----------------+
70+
| pocms/ | pocms:root | |
71+
| jcr:primaryType | NAME | nt:unstructured |
72+
+-----------------+------------+-----------------+
73+
PHPCRSH > cd pocms
74+
PHPCRSH > pwd
75+
/pocms
76+
PHPCRSH > cd ..
77+
PHPCRSH > pwd
78+
/
79+
PHPCRSH > cat jcr:primaryType
80+
nt:unstructured
81+
PHPCRSH > exit
82+
````
83+
84+
The above commands are *aliases*. Aliases are defined in your home directory
85+
in `~/.phpcrsh/aliases.yml`.
86+
87+
Aliases can be listed using the `alist` alias, or `shell:alias:list`.
88+
89+
The above commands would be expanded as:
90+
91+
````bash
92+
PHPCRSH > node:list
93+
PHPCRSH > shell:path:change pocms
94+
PHPCRSH > shell:path:show
95+
PHPCRSH > node:property:show jcr:primaryType
96+
PHPCRSH > shell:exist
97+
````
98+
6399
## Using profiles
64100

65101
Profiles enable you to save and reuse connection settings. Profiles can be

0 commit comments

Comments
 (0)