symfony-cmf/symfony-cmf-docs

[Tutorial] Integrate phpcr-shell

dantleech opened this issue · 2 comments

I am hoping to release PHPCRSH 1.0 around the new year. I think we should switch the tutorial to using the shell rather than the CLI and that it should be included as a dev dependency in the tutorial composer.json.

For example

$ php app/console doctrine:phpcr:node:dump

Would be replaced with

$ php app/console doctrine:phpcr:shell "node:list / -L4"

or we could assume the user has started the shell via php app/console doctrine:phpcr:shell and simple show the command:

PHPCRSH> node:list /

But I know that a number of developers wouldn't use the shell in an efficient way, i.e. they login, run a command, then logout again because they don't know about tabs / tmux etc.

@wouterj @dbu @lsmith77 what do you think about this?

We could maybe add a section to the docs about using the Shell and use the

PHPCRSH> workspace:purge foobar

form thoughout the tutorial (and maybe the rest of the docs).

I personally think the shell exposes more of the potential of PHPCR, but I am biased.

dbu commented

difficult to say indeed. but i tend to say we should switch to use the shell. and explain that there is the shell (just like postgres/mysql/... cli clients) and link to phpcr.github.io that explains the details. and point out (maybe in a couple of strategic places) that the shell can be scripted through the symfony console - this is the main reason to not use the shell i think.

the whole change should only be merged when phpcrsh is released, phpcr-odm released in a version that includes the shell and the sandbox and CMF SE come with the shell.