Skip to content

Commit 7818ec1

Browse files
aborroyaborroy
committed
first commit
0 parents  commit 7818ec1

25 files changed

+1673
-0
lines changed

‎.gitignore

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# If you prefer the allow list template instead of the deny list, see community template:
2+
# https://github.com/github/gitignore/blob/main/community/Golang/Go.AllowList.gitignore
3+
#
4+
# Binaries for programs and plugins
5+
*.exe
6+
*.exe~
7+
*.dll
8+
*.so
9+
*.dylib
10+
11+
# Test binary, built with `go test -c`
12+
*.test
13+
14+
# Output of the go coverage tool, specifically when used with LiteIDE
15+
*.out
16+
17+
# Dependency directories (remove the comment below to include it)
18+
# vendor/
19+
20+
# Go workspace file
21+
go.work

‎LICENSE

+191
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,191 @@
1+
2+
Apache License
3+
Version 2.0, January 2004
4+
https://www.apache.org/licenses/
5+
6+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7+
8+
1. Definitions.
9+
10+
"License" shall mean the terms and conditions for use, reproduction,
11+
and distribution as defined by Sections 1 through 9 of this document.
12+
13+
"Licensor" shall mean the copyright owner or entity authorized by
14+
the copyright owner that is granting the License.
15+
16+
"Legal Entity" shall mean the union of the acting entity and all
17+
other entities that control, are controlled by, or are under common
18+
control with that entity. For the purposes of this definition,
19+
"control" means (i) the power, direct or indirect, to cause the
20+
direction or management of such entity, whether by contract or
21+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
22+
outstanding shares, or (iii) beneficial ownership of such entity.
23+
24+
"You" (or "Your") shall mean an individual or Legal Entity
25+
exercising permissions granted by this License.
26+
27+
"Source" form shall mean the preferred form for making modifications,
28+
including but not limited to software source code, documentation
29+
source, and configuration files.
30+
31+
"Object" form shall mean any form resulting from mechanical
32+
transformation or translation of a Source form, including but
33+
not limited to compiled object code, generated documentation,
34+
and conversions to other media types.
35+
36+
"Work" shall mean the work of authorship, whether in Source or
37+
Object form, made available under the License, as indicated by a
38+
copyright notice that is included in or attached to the work
39+
(an example is provided in the Appendix below).
40+
41+
"Derivative Works" shall mean any work, whether in Source or Object
42+
form, that is based on (or derived from) the Work and for which the
43+
editorial revisions, annotations, elaborations, or other modifications
44+
represent, as a whole, an original work of authorship. For the purposes
45+
of this License, Derivative Works shall not include works that remain
46+
separable from, or merely link (or bind by name) to the interfaces of,
47+
the Work and Derivative Works thereof.
48+
49+
"Contribution" shall mean any work of authorship, including
50+
the original version of the Work and any modifications or additions
51+
to that Work or Derivative Works thereof, that is intentionally
52+
submitted to Licensor for inclusion in the Work by the copyright owner
53+
or by an individual or Legal Entity authorized to submit on behalf of
54+
the copyright owner. For the purposes of this definition, "submitted"
55+
means any form of electronic, verbal, or written communication sent
56+
to the Licensor or its representatives, including but not limited to
57+
communication on electronic mailing lists, source code control systems,
58+
and issue tracking systems that are managed by, or on behalf of, the
59+
Licensor for the purpose of discussing and improving the Work, but
60+
excluding communication that is conspicuously marked or otherwise
61+
designated in writing by the copyright owner as "Not a Contribution."
62+
63+
"Contributor" shall mean Licensor and any individual or Legal Entity
64+
on behalf of whom a Contribution has been received by Licensor and
65+
subsequently incorporated within the Work.
66+
67+
2. Grant of Copyright License. Subject to the terms and conditions of
68+
this License, each Contributor hereby grants to You a perpetual,
69+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70+
copyright license to reproduce, prepare Derivative Works of,
71+
publicly display, publicly perform, sublicense, and distribute the
72+
Work and such Derivative Works in Source or Object form.
73+
74+
3. Grant of Patent License. Subject to the terms and conditions of
75+
this License, each Contributor hereby grants to You a perpetual,
76+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77+
(except as stated in this section) patent license to make, have made,
78+
use, offer to sell, sell, import, and otherwise transfer the Work,
79+
where such license applies only to those patent claims licensable
80+
by such Contributor that are necessarily infringed by their
81+
Contribution(s) alone or by combination of their Contribution(s)
82+
with the Work to which such Contribution(s) was submitted. If You
83+
institute patent litigation against any entity (including a
84+
cross-claim or counterclaim in a lawsuit) alleging that the Work
85+
or a Contribution incorporated within the Work constitutes direct
86+
or contributory patent infringement, then any patent licenses
87+
granted to You under this License for that Work shall terminate
88+
as of the date such litigation is filed.
89+
90+
4. Redistribution. You may reproduce and distribute copies of the
91+
Work or Derivative Works thereof in any medium, with or without
92+
modifications, and in Source or Object form, provided that You
93+
meet the following conditions:
94+
95+
(a) You must give any other recipients of the Work or
96+
Derivative Works a copy of this License; and
97+
98+
(b) You must cause any modified files to carry prominent notices
99+
stating that You changed the files; and
100+
101+
(c) You must retain, in the Source form of any Derivative Works
102+
that You distribute, all copyright, patent, trademark, and
103+
attribution notices from the Source form of the Work,
104+
excluding those notices that do not pertain to any part of
105+
the Derivative Works; and
106+
107+
(d) If the Work includes a "NOTICE" text file as part of its
108+
distribution, then any Derivative Works that You distribute must
109+
include a readable copy of the attribution notices contained
110+
within such NOTICE file, excluding those notices that do not
111+
pertain to any part of the Derivative Works, in at least one
112+
of the following places: within a NOTICE text file distributed
113+
as part of the Derivative Works; within the Source form or
114+
documentation, if provided along with the Derivative Works; or,
115+
within a display generated by the Derivative Works, if and
116+
wherever such third-party notices normally appear. The contents
117+
of the NOTICE file are for informational purposes only and
118+
do not modify the License. You may add Your own attribution
119+
notices within Derivative Works that You distribute, alongside
120+
or as an addendum to the NOTICE text from the Work, provided
121+
that such additional attribution notices cannot be construed
122+
as modifying the License.
123+
124+
You may add Your own copyright statement to Your modifications and
125+
may provide additional or different license terms and conditions
126+
for use, reproduction, or distribution of Your modifications, or
127+
for any such Derivative Works as a whole, provided Your use,
128+
reproduction, and distribution of the Work otherwise complies with
129+
the conditions stated in this License.
130+
131+
5. Submission of Contributions. Unless You explicitly state otherwise,
132+
any Contribution intentionally submitted for inclusion in the Work
133+
by You to the Licensor shall be under the terms and conditions of
134+
this License, without any additional terms or conditions.
135+
Notwithstanding the above, nothing herein shall supersede or modify
136+
the terms of any separate license agreement you may have executed
137+
with Licensor regarding such Contributions.
138+
139+
6. Trademarks. This License does not grant permission to use the trade
140+
names, trademarks, service marks, or product names of the Licensor,
141+
except as required for reasonable and customary use in describing the
142+
origin of the Work and reproducing the content of the NOTICE file.
143+
144+
7. Disclaimer of Warranty. Unless required by applicable law or
145+
agreed to in writing, Licensor provides the Work (and each
146+
Contributor provides its Contributions) on an "AS IS" BASIS,
147+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148+
implied, including, without limitation, any warranties or conditions
149+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150+
PARTICULAR PURPOSE. You are solely responsible for determining the
151+
appropriateness of using or redistributing the Work and assume any
152+
risks associated with Your exercise of permissions under this License.
153+
154+
8. Limitation of Liability. In no event and under no legal theory,
155+
whether in tort (including negligence), contract, or otherwise,
156+
unless required by applicable law (such as deliberate and grossly
157+
negligent acts) or agreed to in writing, shall any Contributor be
158+
liable to You for damages, including any direct, indirect, special,
159+
incidental, or consequential damages of any character arising as a
160+
result of this License or out of the use or inability to use the
161+
Work (including but not limited to damages for loss of goodwill,
162+
work stoppage, computer failure or malfunction, or any and all
163+
other commercial damages or losses), even if such Contributor
164+
has been advised of the possibility of such damages.
165+
166+
9. Accepting Warranty or Additional Liability. While redistributing
167+
the Work or Derivative Works thereof, You may choose to offer,
168+
and charge a fee for, acceptance of support, warranty, indemnity,
169+
or other liability obligations and/or rights consistent with this
170+
License. However, in accepting such obligations, You may act only
171+
on Your own behalf and on Your sole responsibility, not on behalf
172+
of any other Contributor, and only if You agree to indemnify,
173+
defend, and hold each Contributor harmless for any liability
174+
incurred by, or claims asserted against, such Contributor by reason
175+
of your accepting any such warranty or additional liability.
176+
177+
END OF TERMS AND CONDITIONS
178+
179+
Copyright 2023 Angel Borroy
180+
181+
Licensed under the Apache License, Version 2.0 (the "License");
182+
you may not use this file except in compliance with the License.
183+
You may obtain a copy of the License at
184+
185+
https://www.apache.org/licenses/LICENSE-2.0
186+
187+
Unless required by applicable law or agreed to in writing, software
188+
distributed under the License is distributed on an "AS IS" BASIS,
189+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
190+
See the License for the specific language governing permissions and
191+
limitations under the License.

‎Makefile

+29
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
EXECUTABLE=alfresco
2+
WINDOWS=$(EXECUTABLE)_windows_amd64.exe
3+
LINUX=$(EXECUTABLE)_linux_amd64
4+
DARWIN=$(EXECUTABLE)_darwin_arm64
5+
VERSION=1
6+
# VERSION=$(shell git describe --tags --always --long --dirty)
7+
8+
all: build
9+
10+
build: windows linux darwin
11+
@echo version: $(VERSION)
12+
13+
windows: $(WINDOWS)
14+
15+
linux: $(LINUX)
16+
17+
darwin: $(DARWIN)
18+
19+
$(WINDOWS):
20+
env GOOS=windows GOARCH=amd64 go build -v -o $(WINDOWS) -ldflags="-s -w -X main.version=$(VERSION)" ./alfresco.go
21+
22+
$(LINUX):
23+
env GOOS=linux GOARCH=amd64 go build -v -o $(LINUX) -ldflags="-s -w -X main.version=$(VERSION)" ./alfresco.go
24+
25+
$(DARWIN):
26+
env GOOS=darwin GOARCH=arm64 go build -v -o $(DARWIN) -ldflags="-s -w -X main.version=$(VERSION)" ./alfresco.go
27+
28+
clean:
29+
rm -f $(WINDOWS) $(LINUX) $(DARWIN)

‎README.md

+139
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,139 @@
1+
# Alfresco CLI
2+
A Command Line Interface for Alfresco Repository using REST API.
3+
4+
## Usage
5+
6+
Download the binary compiled for your architecture (Linux, Windows or Mac OS) from **Releases**.
7+
8+
>> You may rename the binary to `alfresco`, all the following samples are using this command name by default.
9+
10+
Using `-h` flag provides detail on the use of the different commands available:
11+
12+
```
13+
$ ./alfresco -h
14+
A Command Line Interface for Alfresco Content Services.
15+
16+
Usage:
17+
alfresco [command]
18+
19+
Available Commands:
20+
completion Generate the autocompletion script for the specified shell
21+
config Connection details
22+
help Help about any command
23+
node Manage nodes
24+
25+
Flags:
26+
-h, --help help for alfresco
27+
-o, --output string Output format. E.g.: 'default', 'json' or 'id'. (default "default")
28+
29+
Use "alfresco [command] --help" for more information about a command.
30+
```
31+
32+
## Configuration
33+
34+
Before using interactive commands with Alfresco Repository, defining connection and credentails is required.
35+
36+
Following command will store a connection for ACS deployed in `localhost` with default credentials (admin/admin)
37+
38+
```
39+
./alfresco config set -s http://localhost:8080/alfresco -u admin -p admin
40+
```
41+
42+
>> Note that this command will create a `.alfresco` configuration file on the same folder
43+
44+
## Commands
45+
46+
**Node**
47+
48+
The `node` command provides access to Node handling in Alfresco Repository.
49+
50+
```
51+
./alfresco node -h
52+
Manage nodes
53+
54+
Usage:
55+
alfresco node [command]
56+
57+
Available Commands:
58+
create Create new Node
59+
delete Delete Node
60+
get Get Node information
61+
list Get children nodes
62+
update Update Node information
63+
64+
Flags:
65+
-i, --nodeId string Node Id in Alfresco Repository
66+
```
67+
68+
## Generic flags
69+
70+
```
71+
Flags:
72+
-h, --help help for alfresco
73+
-o, --output string Output format. E.g.: 'default', 'json' or 'id'. (default "default")
74+
```
75+
76+
In addition to `help`, output formatting can be selected by using `-o` or `--output` in every command.
77+
78+
By default formatting is *grepable* text (`default`).
79+
80+
```
81+
$ ./alfresco node list -i -root-
82+
ID NAME MODIFIED AT USER
83+
9bcd0a02-bbed-44f6-baa5-2a27974f9bdf Data Dictionary 2023-04-11T09:21:51.378+0000 System
84+
3cb0e1bc-f349-4651-be79-c5aa4e63465c Guest Home 2023-04-11T09:21:42.711+0000 System
85+
5aaa845d-aaa3-4550-a2f6-2cf78d12c907 Imap Attachments 2023-04-11T09:21:42.761+0000 System
86+
a8e32ff6-6140-4a19-84a5-c157820fc376 IMAP Home 2023-04-11T09:21:42.768+0000 System
87+
08870377-0da9-4a2d-964c-e77e4f3b5e21 Shared 2023-04-25T13:48:13.831+0000 admin
88+
44847591-6db1-44f8-a09d-e91385de3583 Sites 2023-04-11T09:21:50.198+0000 System
89+
308b599d-6653-4190-aee3-18e6a0f7e9fd User Homes 2023-04-13T14:21:40.945+0000 admin
90+
```
91+
92+
In order to get raw JSON Response, `json` parameter can be used.
93+
94+
```
95+
$ ./alfresco node list -i -root- -o json
96+
{
97+
"pagination" : {
98+
"count" : 7,
99+
"hasMoreItems" : false,
100+
"totalItems" : 7,
101+
"skipCount" : 0,
102+
"maxItems" : 100
103+
},
104+
"entries" : [ {
105+
"entry" : {
106+
"id" : "9bcd0a02-bbed-44f6-baa5-2a27974f9bdf",
107+
"name" : "Data Dictionary",
108+
"nodeType" : "cm:folder",
109+
"isFolder" : true,
110+
"isFile" : false,
111+
"isLocked" : false,
112+
...
113+
}
114+
```
115+
116+
And finally, a list of IDs can be obtained using `id` option.
117+
118+
```
119+
$ ./alfresco node list -i -root- -o id
120+
9bcd0a02-bbed-44f6-baa5-2a27974f9bdf
121+
3cb0e1bc-f349-4651-be79-c5aa4e63465c
122+
5aaa845d-aaa3-4550-a2f6-2cf78d12c907
123+
a8e32ff6-6140-4a19-84a5-c157820fc376
124+
08870377-0da9-4a2d-964c-e77e4f3b5e21
125+
44847591-6db1-44f8-a09d-e91385de3583
126+
308b599d-6653-4190-aee3-18e6a0f7e9fd
127+
```
128+
129+
## Sample script
130+
131+
Sample bash script for testing purposes is provided in [sample/test.sh] file.
132+
133+
## TODO
134+
135+
* TLS protocol support
136+
* Site commands
137+
* Person commands
138+
* Group commands
139+
* Search commands

‎alfresco.go

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
package main
2+
3+
import (
4+
"github.com/aborroy/alfresco-cli/cmd"
5+
_ "github.com/aborroy/alfresco-cli/cmd/config"
6+
_ "github.com/aborroy/alfresco-cli/cmd/node"
7+
)
8+
9+
func main() {
10+
cmd.Execute()
11+
}

0 commit comments

Comments
 (0)